volanea_create_webhook_endpoint
Register an endpoint in the user's app to receive Volanea events, and get back its whsec_… SIGNING SECRET — you need that secret to write the signature-verification code into their codebase (see volanea_get_api_reference { resource: 'Webhooks' } for the X-Volanea-Signature scheme). Idempotent by URL. Events are matched by pattern, e.g. ["email.*", "contact.created"]; omit to receive everything. The URL must be reachable from the public internet: deliveries are made from Volanea's servers, so http://localhost:3000 or a private LAN address receives nothing — tunnel the dev server (ngrok, cloudflared) and register the tunnel URL instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | HTTPS endpoint in the user's app, e.g. https://app.example.com/webhooks/volanea | |
| events | No | Event patterns to subscribe to, e.g. ["email.delivered", "email.bounced"]. Omit for all events. | |
| description | No | Optional label for the dashboard's endpoint list — e.g. "staging receiver", or the service that owns it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Machine-readable failure code to branch on. Present only when success is false. | |
| data | No | Present when success is true. | |
| error | No | Human-readable failure reason. Present only when success is false. | |
| success | Yes | False when the call failed; read `error` and `code` in that case. |