Webhooks
Create Webhook
Register a new webhook endpoint to receive real-time event notifications.
POST
Create Webhook
Request
The HTTPS URL to deliver events to. Must use
https:// in production. Subject to SSRF validation — private IPs, cloud metadata endpoints, and non-HTTP schemes are blocked.Array of event types to subscribe to. Use
"*" for all events, or specific types like "completion.created".Valid types: completion.created, job.completed, job.failed, workflow.completed, workflow.failed, skill.installed, skill.uninstalled, skill.submitted, skill.approved, skill.rejected, skill.suspended, connector.created, connector.status_changed, credits.low, key.created, key.revoked, *Optional custom signing secret (16–256 chars). If omitted, a cryptographically random 32-byte hex secret is generated.
Optional description for the webhook (max 256 chars).
Response
The webhook’s unique UUID.
The registered endpoint URL.
Subscribed event types.
Always
true on creation.The HMAC-SHA256 signing secret. Shown once — save it immediately. Used to verify webhook signatures on your server.
ISO 8601 timestamp.
Authentication
Requires an org-scoped API key withcompletions scope.
Example
Response
Limits
- A per-organization cap on active webhooks applies. If you need more, contact support.
- URL must pass SSRF validation (no private IPs, no cloud metadata endpoints).
- HTTPS required in production.
Signature Verification
Every delivery includes three headers for verification:HMAC-SHA256(signing_secret, timestamp + "." + raw_body) and comparing to the signature. Reject if the timestamp drifts more than 5 minutes from your clock.
Create Webhook
