Skip to navigation
API ReferenceWebhooks

Update Subscription

Update an existing webhook subscription.

Use this endpoint to modify a subscription’s configuration. You can:

  • Change the URL: Update where events are delivered
  • Update event types: Modify which events trigger notifications
  • Enable/disable: Temporarily pause delivery without deleting the subscription
  • Recover messages: When re-enabling, optionally recover missed messages

Only include the fields you want to change. Omitted fields will retain their current values.

When re-enabling a subscription (disabled: false), you can optionally provide recover_since to automatically retry all messages that were generated while the subscription was disabled.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

subscription_idstringRequired

The unique identifier of the subscription to update (UUID).

Request

This endpoint expects an object.
urlstring or nullOptionalformat: "uri"1-2083 characters
New URL for webhook delivery. Must be a publicly accessible HTTPS endpoint.
event_typeslist of enums or nullOptional
New list of event types to subscribe to. This replaces the existing list entirely.
disabledboolean or nullOptional

Set to true to pause delivery to this subscription, or false to resume. Disabled subscriptions will not receive events.

recover_sincestring or nullOptionalformat: "date-time"

When re-enabling a subscription (disabled: false), optionally recover failed messages from this timestamp. Only applies when enabling.

Response

Updated subscription
idstring

Unique identifier for this subscription (UUID format)

urlstring
The URL where webhook events are delivered
created_atstringformat: "date-time"

When this subscription was created (ISO 8601 format, UTC)

updated_atstringformat: "date-time"

When this subscription was last updated (ISO 8601 format, UTC)

filter_typeslist of strings or nullOptional
Event types this subscription is filtered to receive. See EventType enum for all available types.
disabledbooleanOptionalDefaults to false
Whether this subscription is currently disabled. Disabled subscriptions do not receive event deliveries.
descriptionstring or nullOptional

Optional human-readable description of this subscription

health_statusenumOptional

Health status of this subscription based on recent delivery attempts. Values: 'healthy' (all recent deliveries succeeded), 'degraded' (mix of successes and failures), 'failing' (consecutive failures beyond threshold), 'unknown' (no delivery data yet).

Allowed values:

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error