Webhooks

Create an endpoint

Registers a URL to receive event deliveries. The response includes the signing secret (whsec_…). Deliveries retry with backoff for ~24h and carry X-Volanea-Signature: t=<ms>,v1=<hmac-sha256 hex of "<t>.<body>">.

post/v1/webhooks

Request

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

Request body

urlstring uri required
descriptionstring
eventsstring[]

Patterns like "email.*" or exact names. Omit for all events.

Response

Created, with the signing secret.

webhookEndpointIdstring required
projectIdstring
urlstring uri required
descriptionstring nullable
secretstring required

whsec_… — used to HMAC-SHA256-sign every delivery (X-Volanea-Signature: t=<ms>,v1=<hex> over <t>.<body>).

eventsstring[] nullable

Event name patterns, e.g. ["email.*", "contact.created"]. Empty or null = all events.

enabledboolean required
createdAtstring date-time required

Changes

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