Passer au contenu principal
PUT
Update a webhook endpoint

Autorisations

Authorization
string
header
requis

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Paramètres de chemin

id
string<uuid>
requis

Corps

application/json
url
string<uri>

Public HTTPS URL

Exemple:

"https://example.com/webhooks/shortext"

events
string[]
Exemple:
filters
object | null

Only receive events whose context matches, e.g. one agent

Exemple:
description
string | null
is_enabled
boolean

Réponse

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success
boolean
Exemple:

true

code
integer
Exemple:

1000

message
string
Exemple:

"Request success."

body
object

Endpoint payload, null when there is none

token
string | null

Present only on authentication routes

trace_id
string | null

Present only when success is false