What Connections Supports

❗️

Connections doesn't support Contact/Agent Sync.

Content Types

The input and output of the action execution must be application/JSON or application/x-www-form-urlencoded, as these are the supported content types formats.
Note that if the content type is application/x-www-form-urlencoded then the request body will be sent as a form.

JSON

The input and output of the action execution must be JSON, as this is the supported format.

Arrays

It's possible to configure an action schema from which one or more fields are the array type.
However, to use such an action in Studio it's also necessary to use the Run Function Studio component.

🚧

The output schema must only contain the properties that are going to be used within Talkdesk (in Studio for instance). This way, a possibly not supported field will not impact the action configuration nor its usage.

Multi-type Variables

While multi-type variables (such as type: [“string”,”null”]) can be configured in the input/output schema of an action, there are certain limitations to consider when configuring the Studio Execute Action component:

Supported Combinations:

1. We support all combinations of two types where one of the types is null. For example: [“string”,” null”], [“boolean, null”], [“array, null”], [“number, null”], [“object, null”],
   Example usage: A variable can either be a string or null.
2. Unsupported Combinations:
   We do not support combinations of more then two types, even if one of them is null. For example: [“string”, “boolean”, “null”], [“string”, “number”, “null”]
   We also do not support combinations of two types where neither is null. For example: [“string,” boolean”], [“string, array”]
   Example usage: A variable cannot be both a string and a boolean simultaneously.
   Please note that multi-type variables cannot be marked as required.

🚧

Connections - Property Types

Null Variables

While null type variables (type: null) can be configured as part of a multi-type variable, as described in the previous section, there are limitations when configuring the Studio Execute Action component:

1. Null as part of Multi-type Variables:
   Null can be used as part of a multi-type variable, such as [“string”,”null”], [“boolean”,”null”], or [“number”,”null”], as described in the previous section.
2. Limitations in Studio Execute Action Component:
   However, a variable cannot be solely null and used in the Studio Execute Action component.

Authentication

Types of authentication (not variations of them) that can be configured with Connections:

• No authentication.
• Basic authentication.
• X-API-Key.
• OAuth2 Client Credentials.
• OAuth2 Client Credentials V2.
• OAuth2 Client Credentials with scopes.
• OAuth2 Resource Owner.
• OAuth2 Resource Owner V2.
• OAuth2 Authorization Code Flow.
• OAuth Client Credentials with Private Key JWT

Additional parameters on requests

Additional parameters can be configured at the following levels:

For more information please refer to the Custom Connection article.

Standard Implementations

HTTP basic authentication and OAuth follow the Request for Comments (RFC) standard. However, there is no RFC for the X-API-Key authentication.

📘

More Information

HTTP Basic Authentication

X-API-Key

OAuth2

The authentication types available cover the majority of use cases, as they are the most commonly used on public API systems.

Timeout

Connections supports timeout configuration. This allows you to choose between a five-second timeout (minimum) and a 30-second timeout (maximum) when configuring an action. This timeout represents the elapsed time from the moment the action is triggered until a response is received from the third-party API.

Encoding

Types of encoding that can be configured with Connections (for each custom action):

No encoding
Full encoding (RFC 3986)
UTF-8 encoding

By default, Full encoding (RFC 3986) is being applied to custom actions.

Connections IP

Connections does not have a specific Talkdesk IP associated. To understand which IPs can be associated with the external requests made by Connections, please refer to this article.

🚧

Troubleshooting

If you have questions or technical issues, please open a ticket using this form.