Webhooks

Create a webhook

Registers a webhook endpoint for one or more event types. The signing secret (whsec_…) is returned ONCE in this response — store it; you'll use it to verify payload signatures.

Required scope: webhooks:write.

Requires a unique Idempotency-Key request header so retries never duplicate.

post/webhooks

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/webhooks
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

A unique key (e.g. a UUID) that makes this write safe to retry. Reusing a key returns the original result; reusing it with a different body returns 409.

Request body

urlstring uri required

HTTPS URL that receives POST deliveries.

eventsstring[] required

Event types to subscribe to (see Webhook Events).

Response

Success

Changes

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