SVsvix
Webhook Endpoint

Upsert Operational Webhook Endpoint

Changed on

Create or update an operational webhook endpoint.

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

Request

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

Path parameters

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

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

  • 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