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

Changes

Changed in 1 of the 5 revisions of this API.43

  • dc130bd1b07443See the full diff
    • ●

      removed the request property filterTypes

      request-property-removed

    • ●

      removed the request property rateLimit

      request-property-removed

    • ●

      removed the optional property filterTypes from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property rateLimit from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id v1.operational-webhook.endpoint.update removed and replaced with v1.operational-webhook.endpoint.upsert

      api-operation-id-removed

    • ○

      added the new optional request property eventTypes

      new-optional-request-property

    • ○

      added the optional property eventTypes to the response with the 200 status

      response-optional-property-added

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog