Create a webhook (free)
create_webhookRegister a URL to receive bulk-job completion events, so scheduled workflows get notified instead of polling; each event body includes job results.
Instructions
Register a URL that receives bulk-job completion events, so scheduled or unattended workflows are notified instead of polling. Each event carries the job's results (emails, phone numbers or records) in its body. Free: this call never spends credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | URL that receives the events, http or https. The API refuses a host that resolves to a private or internal address. | |
| events | Yes | Events to subscribe to. | |
| secret | No | Shared secret for HMAC signature verification. | |
| timeout_ms | No | Request timeout in milliseconds. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cost | No | ||
| action | No | ||
| webhooks | No | ||
| test_mode | No | ||
| test_mode_notice | No | ||
| vocabulary_warnings | No | ||
| deprecated_params_ignored | No |