SVsvix
Webhook Endpoint

Create Operational Webhook Endpoint

Changed on

Create an operational webhook endpoint.

post/api/v1/operational-webhook/endpoint

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/operational-webhook/endpoint
  • Auth
    HTTP bearer

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

  • cca56e67e5a4Revision changes
    • warning

      the request property's maxLength was set to 4096

    • info

      added the required property to the response with the status

  • 8b2683298928Revision changes
    • warning

      the request property's max was set to 65535.00