Sign in

Update a webhook endpoint status.

Status transitions:

  • active: Re-enables the endpoint. Use this to:
    • Unpause a paused endpoint
    • Re-enable an endpoint that is backing-off or disabled due to delivery failures
    • When re-enabled, any queued notifications will be sent
  • paused: Pauses the endpoint. While paused:
    • New notifications are queued (not lost)
    • No delivery attempts are made
    • Use active to resume and process queued notifications
  • archived: Permanently archives the endpoint (soft delete)

Note: The backing-off and disabled statuses are system-managed and cannot be set directly. These occur automatically when delivery failures are detected. Use active to re-enable.

patch/webhook/{webhookId}

Path parameters

webhookIdstring required

Request body

status'active' | 'paused' | 'archived' required

The desired status for the endpoint:

  • active: Enable/re-enable the endpoint
  • paused: Pause the endpoint (notifications are queued)
  • archived: Archive the endpoint (soft delete)
reasonstring

Optional reason for the status change (for audit purposes)

Response

OK

idstring required
createdAtstring required
archivedAtstring
urlstring required

The URL that will receive the webhook payload

namestring required

The name of the webhook

status'active' | 'paused' | 'backing-off' | 'disabled' required

The current status of the webhook endpoint:

  • active: The webhook is enabled and receiving events normally.
  • paused: The webhook has been paused by the user. Events are queued and will be delivered when the endpoint is set back to active.
  • backing-off: The system is temporarily backing off due to delivery failures. Delivery will be automatically retried at backingOffUntil. You can also immediately re-enable by setting status to active via the PATCH endpoint.
  • disabled: The webhook has been automatically disabled due to repeated delivery failures. Re-enable by setting status to active via the PATCH endpoint.
pausedAtstring

When the endpoint was paused by the user (ISO 8601 timestamp)

backingOffUntilstring

When the system will automatically retry delivery (ISO 8601 timestamp). Only present when status is backing-off.

disabledAtstring

When the endpoint was automatically disabled due to repeated failures (ISO 8601 timestamp). Only present when status is disabled.

Changes

Changed in 1 of the 2 revisions of this API.6

  • 773c90f079c56See the full diff
    • ○

      added the new active enum value to the request property status

      request-property-enum-value-added

    • ○

      added the new paused enum value to the request property status

      request-property-enum-value-added

    • ○

      added the optional property backingOffUntil to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property disabledAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property pausedAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property status to the response with the 200 status

      response-required-property-added