API ReferenceEvent Subscriptions

Update subscription

Updates one or more fields of an event subscription. Fields not included in the request body are left unchanged. - To rotate the signing secret, include a new `signingSecret` value. All subsequent deliveries will use the new secret. - Set `status` to `paused` to temporarily suppress deliveries without deleting the subscription.

Authentication

Authorizationstring
Pass your API key in the `Authorization` header using the prefix `api-key`: ``` Authorization: api-key YOUR_API_KEY ```

Path parameters

subscriptionIdstringRequired
Event subscription identifier.

Request

This endpoint expects an object.
endpointUrlstringOptionalformat: "^https://.+$"
New HTTPS endpoint URL.
eventTypeslist of enumsOptional
Replaces the full list of subscribed event types.
Allowed values:
signingSecretstringOptional

Rotates the signing secret. All deliveries sent after this update will be signed with the new value. Update your server-side verification logic before rotating to avoid rejecting legitimate deliveries.

filtersobjectOptional
Optional filters that narrow which events are delivered to this subscription. All configured filter conditions must match for an event to be delivered.
statusenumOptional

Set to paused to suppress deliveries without deleting the subscription. Set back to active to resume.

Allowed values:

Response

OK
idstring
Subscription identifier.
statusenum

active — deliveries are attempted. paused — deliveries are suppressed; use PATCH to resume.

Allowed values:
endpointUrlstring
HTTPS URL where event payloads are delivered.
eventTypeslist of enums
Event types this subscription is configured to receive.
Allowed values:
filtersobject
Optional filters that narrow which events are delivered to this subscription. All configured filter conditions must match for an event to be delivered.
createdAtdatetime
updatedAtdatetime