webhooks

Rotate a webhook secret

Replace one of your webhooks' signing secret and return the new one once.

For 24 hours each delivery is signed with both secrets (two webhook-signature entries), so your receiver can switch without missing an event.

post/v1/webhooks/{id}/rotate-secret

Request

  • Base URL: https://api.pomerado.ai
  • URL: https://api.pomerado.ai/v1/webhooks/{id}/rotate-secret
  • Auth: HTTP bearer

Path parameters

idstring required
Example:wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190

a webhook ID: wh_ and 32 lowercase hex digits

Response

The webhook and its new one-time secret

idstring required

a webhook ID: wh_ and 32 lowercase hex digits

urlstring required
eventsstring[] required
status'active' | 'disabled' required
disabled_reason'manual' | 'gone' | 'unreachable' | 'secret_unreadable' nullable required

Why a disabled webhook sends nothing: manual (turned off), gone (its receiver answered 410), unreachable (20 failed deliveries in a row) or secret_unreadable (rotate its secret)

created_atstring required

a string to be decoded into a Date

last_delivery_atstring required

a string to be decoded into a Date

secretstring required

The Standard Webhooks signing secret (whsec_…), shown only in this response. Verify each delivery's webhook-signature with it.

Example response

{
  "id": "wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
}

Changes

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