Partner Webhooks

Update Partner Webhook Subscription

Updates a partner webhook subscription. Returns the updated subscription, including a new signing secret when you request a rotation.

patch/partner/webhooks/subscriptions/{subscription_id}

Request

Path parameters

subscription_idstring uuid required

The webhook subscription.

Request body

namestring nullable

New label for the subscription. Omit to leave it unchanged.

urlstring uri nullable

New HTTPS endpoint to POST events to. Omit to leave it unchanged.

event_typesWebhookEventType[] nullable

Replacement list of event types to deliver. Omit to leave the current selection unchanged. An empty list is rejected.

rotate_secretboolean

Issue a new signing secret. The new plaintext secret is returned once in this response and never again.

expire_previous_secretboolean

Set to true with rotate_secret to stop signing with the old secret right away. Use this when you believe the old secret leaked. By default, Meow signs each delivery with both the old and the new secret for 7 days, so you can update your receiver without rejecting any deliveries.

is_enabledboolean nullable

Set to true to re-enable a subscription Meow disabled after repeated delivery failures, a 410 Gone response, or an unsafe URL. The subscription keeps its id and delivery history. Omit to leave it unchanged.

payload_mode'snapshot' | 'thin'

Response

Successful Response

OR

Changes

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