Webhooks

Update a webhook subscription

Update a subscription's URL, subscribed events, label, or active state. Only the provided fields are changed. The secret cannot be changed or retrieved — delete and recreate to rotate it.

Authentication:
- API key with READ_WRITE permission
patch/webhooks/{webhook_id}

Request

  • Base URL: https://api.yourang.ai/v1
  • URL: https://api.yourang.ai/v1/webhooks/{webhook_id}
  • Auth: API Key (a scheme the document does not define)

Path parameters

webhook_idstring uuid required

Request body

webhook_urlstring nullable

New destination URL.

eventsstring[] nullable

Replacement set of subscribed event types.

descriptionstring nullable

New human-readable label.

is_activeboolean nullable

Enable or disable deliveries to this subscription.

Response

Subscription updated

unknown required

Changes

No recorded changes to this endpoint across all 8 revisions of this API.