Skip to main content

Support & Resources

IVR (Auto Attendant) webhooks

Premium Features

Loading...

IVR (Auto Attendant) webhooks

IVR (Auto Attendant) webhooks

Follow every step of a caller's journey through your IVR menu: when they arrive, which keys they press, where they are sent, and how the call ends.

Where to set it up

  1. Go to Premium Features > Premium IVR and open the IVR you want to edit.
  2. Open the Alerts & Webhooks tab.
  3. In the HTTP webhooks card, turn the webhook switch on.
  4. Enter your address in Webhook endpoint URL.
  5. Optional: enter a Webhook HMAC secret (up to 64 characters).
  6. Click Save alerts & webhooks.

Click Webhook docs on the same tab to see example messages.

Webhooks are independent of the Call completion alerts (email and SMS) on the same page. You can turn either on without the other.

Events you will receive

EventWhen it is sent
ivr.startedA call has arrived at the IVR.
ivr.dtmf_receivedThe caller pressed a key on their keypad.
ivr.routedThe IVR chose where to send the caller and started connecting them.
ivr.completedThe call finished normally.
ivr.abandonedThe caller hung up before the call finished normally.

Example message

{
  "event": "ivr.started",
  "account_code": "295327",
  "ivr_uuid": "550e8400-e29b-41d4-a716-446655440000",
  "call_uuid": "550e8400-e29b-41d4-a716-446655440020",
  "status": "received",
  "caller_id": "61400111222",
  "original_did": "61298786988",
  "created_at": "2026-06-07T00:00:00Z"
}

Extra details are included in a data section depending on the event:

EventExtra details
ivr.dtmf_receiveddigit (the key pressed), menu_uuid (which menu), action (what the key does).
ivr.routeddestination_type and destination (where the caller was sent), final_action.
ivr.completedhangup_cause, final_action, total_duration_sec (call length in seconds).
ivr.abandonedhangup_cause and dtmf_path, a list of every key the caller pressed before hanging up.

dtmf_path is useful for spotting where callers give up in your menu.

Security

If you set a secret, each request includes:

X-Crazytel-Signature-256: sha256=<signature>
User-Agent: Crazytel-IVR-Webhook/1.0

See Verifying webhook signatures.

Cost

Email alerts and webhooks are included at no platform charge. SMS alerts are billed per segment.

Need Help?