API Endpoint
When a user opens a ticket, a HTTP {data.http_method}
request will be sent to the
provided
request
URL. The URL must respond with a valid JSON payload.
Secrets
If creating a public integration, you may wish to let users provide secret values, e.g. API keys, instead of sending all requests through your own.
Note: Do not include the %
symbols in secret names, they will be automatically
included
{/if}
Request Headers
You can specify up to 5 HTTP headers that will be sent with the request, for example, containing
authentication
keys. You may specify the user's ID in a header, via %user_id%
.
You may also include the values of secrets you have created, via %secret_name%
.
{#if data.secrets.length > 0}
For example, %{data.secrets[0].name}%
.
{/if}
The response must contain a valid JSON payload. This payload will be parsed, and values can be extracted to use as placeholders in your welcome message.
Do not include the % symbols in the placeholder names. They will be included automatically.
The JSON path is the key path to access a field in the response JSON. You can use a period
(e.g. user.username
) to access nested objects.
You will be presented with an example JSON payload as you type.
Example Response
The request must be responded to with a JSON payload in the following form:
{exampleJson}