Sign in
latestOpenAPI 3.1.02026-08-211286041.7 MB

b0c8a1820333

Webhook Endpoint

Upsert Operational Webhook Endpoint

Create or update an operational webhook endpoint.

put/api/v1/operational-webhook/endpoint/{endpoint_id}

Path parameters

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Request body

descriptionstring
disabledboolean
eventTypesstring[] nullable
metadataobject
throttleRateinteger nullable

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the endpoint.

urlstring uri required

Example request

{
  "description": "An example endpoint name",
  "eventTypes": [
    "message.attempt.failing"
  ],
  "uid": "unique-identifier",
  "url": "https://example.com/webhook/"
}

Response

createdAtstring date-time required
descriptionstring required
disabledboolean
eventTypesstring[] nullable
idstring required

The Endpoint's ID.

metadataobject required
throttleRateinteger nullable

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the endpoint.

updatedAtstring date-time required
urlstring uri required

Example response

{
  "eventTypes": [
    "message.attempt.failing"
  ],
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "uid": "unique-identifier",
  "url": "https://example.com/webhook/"
}