Webhooks

Update outbound webhook

Changed on

Updates an outbound webhook endpoint URL, name, status, or subscribed events. Changing the URL or enabling the endpoint resets stored endpoint failure state, including failingSince and autoDisabledAt.

patch/webhooks/{id}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/webhooks/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

namestring
urlstring uri
status'enabled' | 'disabled'
eventsOutboundWebhookEventType[]

Response

Updated

successboolean

Example response

{
  "webhook": {
    "id": "webhook_abc123",
    "name": "Production webhook",
    "url": "https://example.com/sequenzy/webhooks",
    "signingSecret": "whsec_...",
    "signingSecrets": [
      {
        "id": "sec_abc123",
        "prefix": "whsec_abcd12"
      }
    ]
  }
}

Changes

  • db3873ca3d4dRevision changes
    • warning

      added the new email.received enum value to the // response property for the response status

    • info

      added the new email.received enum value to the request property /

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 11b6d27ba1deRevision changes
    • warning

      added the new campaign.sent enum value to the // response property for the response status

    • info

      added the new campaign.sent enum value to the request property /