Sign in
latestOpenAPI 3.1.02026-08-211286041.7 MB

b0c8a1820333

Webhook Endpoint

Get Operational Webhook Endpoint

Get an operational webhook endpoint.

get/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.

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/"
}