Set Webhook
webhook_setCreate or update a webhook subscription (upsert). If id is provided the call updates that webhook (PUT). If omitted it creates a new one (POST) — url and events are then required. Use this for declarative 'ensure webhook X exists' workflows.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Webhook ID. Present → updates that webhook (PUT). Omitted → creates a new one (POST). | |
| url | No | HTTPS endpoint URL that will receive event payloads. Required on create; optional on update. | |
| active | No | Whether the webhook is active. Defaults to true on create. | |
| events | No | List of event types to subscribe to (e.g. 'message.received', 'email.bounced'). Required on create; optional on update. | |
| authConfig | No | Auth the platform presents to your endpoint IN ADDITION to the always-on X-Anima-Signature HMAC — a bearer token, HTTP basic, or a custom header. Pass { type: 'none' } to remove it. | |
| description | No | Optional human-readable label | |
| maxAttempts | No | Max delivery attempts before dead-lettering (default 3) | |
| rateLimitPerMinute | No | Max deliveries per minute to this endpoint; omit for unlimited |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||