Sign in
Events & Batch Operations
events_and_batch

Update Webhook

Update a webhook subscription.

patch/api/v1/events/webhooks/{subscription_id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

subscription_idstring required

Headers

X-API-Keystring nullable

Request body

urlstring uri nullable
event_typesstring nullable
resource_typesstring nullable
activeboolean nullable
paused_reasonstring nullable
max_retriesinteger nullable
rate_limit_per_minuteinteger nullable
descriptionstring nullable
custom_headersobject nullable

Response

Successful Response

idstring required
organization_idstring required
urlstring required
event_typesstring required
resource_typesstring nullable required
activeboolean required
paused_atstring date-time nullable required
paused_reasonstring nullable required
max_retriesinteger required
retry_delay_secondsinteger required
rate_limit_per_minuteinteger nullable required
delivered_countinteger required
failed_countinteger required
last_delivery_atstring date-time nullable required
last_errorstring nullable required
descriptionstring nullable required
custom_headersobject nullable required
created_atstring date-time required
created_by_user_idstring nullable required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.