Sign in
Webhook Endpoint

Create Operational Webhook Endpoint

Create an operational webhook endpoint.

post/api/v1/operational-webhook/endpoint

Headers

idempotency-keystring

The request's idempotency key

Request body

descriptionstring
disabledboolean
eventTypesstring[] nullable
headersobject nullable
metadataobject
secretstring nullable

The endpoint's verification secret.

Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.

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"
  ],
  "headers": {
    "X-Example": "123",
    "X-Foobar": "Bar"
  },
  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD",
  "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 201 status

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ○

      added the new optional request property eventTypes

      new-optional-request-property

    • ○

      added the new optional request property headers

      new-optional-request-property

    • ○

      added the optional property eventTypes to the response with the 201 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