SVsvix
Webhook Endpoint

Get Operational Webhook Endpoint

Changed on

Get an operational webhook endpoint.

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

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
    • info

      added the required property to the response with the status

  • dc130bd1b074Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status