webhooks

Create an outbound webhook subscription.

Push reply, bounce, soft_bounce, complaint, and unsubscribe events to your own HTTPS endpoint instead of polling GET /activity. Deliveries are signed X-Coldrig-Signature: sha256=HMAC-SHA256(secret, raw body). URLs must be https and resolve to a public host — private/link- local/metadata IPs are rejected, re-validated on every delivery.

post/webhook-subscriptions

Request

  • Base URL: https://api.coldrig.dev
  • URL: https://api.coldrig.dev/webhook-subscriptions
  • Auth: HTTP bearer

Request body

urlstring required

HTTPS endpoint that receives event POSTs. Must be https and resolve to a public host — private/link-local/metadata IPs are rejected.

eventTypesWebhookEventType[] required

Which event types to receive. At least one.

secretstring

Optional HMAC signing secret (>=16 chars). Omit to have the server generate one, returned once on create.

activeboolean

Whether the subscription delivers immediately. Defaults to true.

Response

Subscription created — the response carries the signing secret once.

idstring required
urlstring required
eventTypesWebhookEventType[] required
activeboolean required
status'active' | 'disabled' required
disabledReasonstring nullable required
consecutiveFailuresinteger required
createdAtinteger required
updatedAtinteger required
secretstring required

HMAC signing secret — shown once on create, never returned on reads.

Changes

No recorded changes to this operation across all 2 revisions of this API.