Webhooks

Update a webhook subscription

Updates the destination URL, status, or event pattern set for an existing webhook subscription. The caller must also have read scopes for the subscription's event families.

put/v1/webhook-subscriptions/{webhook_subscription_id}

Request

  • Base URL: https://api.mailrith.com
  • URL: https://api.mailrith.com/v1/webhook-subscriptions/{webhook_subscription_id}
  • Auth: HTTP bearer

Path parameters

webhook_subscription_idstring required

The webhook subscription identifier.

Request body

namestring
urlstring

Public HTTPS destination URL for signed event delivery. Localhost, private network, link-local, and reserved destinations are not accepted.

event_patternsstring[]
status'active' | 'disabled'

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.