Events
Overview
Webhooks allow you to receive real-time HTTP notifications when events occur in your KrosAI account.
Setup
Follow the steps below to configure a webhook endpoint from your KrosAI Dashboard.
1
Go to the Webhooks page
Go to Developers → Webhooks in the Dashboard.
2
Create a webhook
Click Create Webhook.
3
Enter your endpoint
Enter your endpoint URL.
4
Select events
Select the events you want to subscribe to.
5
Save and copy secret
Save the webhook and copy the signing secret.
Keep your signing secret safe — you will need it to verify incoming webhook payloads.
Available Events
Subscribe only to the events your application needs. For full payload schemas, see the API Reference.
| Call | Call is initiated (inbound or outbound) |
| Call | Destination is ringing |
| Call | Call is answered |
| Call | Call ends normally |
| Call | Call fails to connect |
| Phone Number | Phone number is purchased |
| Phone Number | Phone number is released |
| Phone Number | Phone number configuration changes |
| Endpoint | Endpoint is created |
| Endpoint | Endpoint is updated |
| Endpoint | Endpoint is deleted |
| Recording | Call recording is processed and available |
| Recording | Call transcript is processed and available |
| Port Request | Port request is submitted |
| Port Request | Port request is completed successfully |
| Port Request | Port request fails |
| Billing | Account balance falls below threshold |
| Billing | Payment is received on the account |
Payload Structure
Every webhook payload follows the same envelope structure regardless of event type.
| string | Unique event identifier |
| string | Event name (e.g. call.initiated) |
| string | ISO 8601 timestamp of when the event occurred |
| object | Event-specific payload. See API Reference for full schema per event. |
Signature Verification
Always verify the webhook signature before processing any payload. Skipping this step exposes your endpoint to spoofed requests.
Verify the X-Webhook-Signature header.
Retry Policy
Your endpoint must respond with HTTP 2xx within 10 seconds. Failure to do so will trigger the retry schedule below.
1 | Immediate |
2 | 1 minute |
3 | 5 minutes |
4 | 30 minutes |
5 | 2 hours |
After 5 failed attempts, the webhook will be disabled automatically. You must re-enable it manually from the Dashboard.
Event Subscriptions
Event Wildcards
Subscribe to all events in a category:
call.*— All call eventsphone_number.*— All phone number events*— All events
On this page
- Events