Webhooks
Create webhook
Create a new webhook.
post/webhooks
Query parameters
type'v2.billing.credit.topup' | 'v2.billing.credit.warning' | 'v2.billing.credit.shutdown' | 'v2.call.inbound.started' | 'v2.call.inbound.ended' | 'v2.call.outbound.started' | 'v2.call.outbound.ended' | 'v2.number.assigned' | 'v2.number.unassigned' | 'v2.task.updated' | 'v2.audio-file.updated' | 'v2.recording.updated' | 'v2.sms.inbound.received' | 'v2.sms.outbound.updated' required
- v2.billing.credit.topup = Your account has been credited with a new amount.
- v2.billing.credit.warning = Your prepaid balance has reached its warning level.
- v2.billing.credit.shutdown = Your prepaid balance has reached its shutdown level. Your account is suspended.
- v2.call.inbound.started = An inbound call just started.
- v2.call.inbound.ended = An inbound call just hung up.
- v2.call.outbound.started = An outbound call just started.
- v2.call.outbound.ended = An outbound call just hung up.
- v2.number.assigned = A phone number was assigned to your account.
- v2.number.unassigned = A phone number was unassigned from your account.
- v2.task.updated = A task has been updated.
- v2.audio-file.updated = An audio file has been updated.
- v2.recording.updated = A recording has been updated.
- v2.sms.inbound.received = An inbound SMS has been received.
- v2.sms.outbound.updated = An outbound SMS has an updated status.
Request body
Example request
{
"endpoint": "https://example.com",
"options": {
"hmac": {
"algorithm": "sha512"
}
}
}Response
Webhook created
Example response
{
"sid": "callrsid",
"endpoint": "https://example.com",
"status": "enabled",
"options": {
"hmac": {
"algorithm": "sha512"
}
},
"lastfailed": "2024-04-24T17:42:28Z",
"created": "2024-04-24T17:42:28Z",
"updated": "2024-04-24T17:42:28Z"
}