Skip to main content

Support & Resources

Ring Groups webhooks

Premium Features

Loading...

Ring Groups webhooks

Ring Groups webhooks

Get notified as a Ring Group call rings your team, when someone answers, and when the call ends.

Where to set it up

  1. Go to Premium Features > Ring Groups and open the group you want to edit.
  2. Open the Alerts & Webhooks tab.
  3. In the HTTP Webhooks card, turn the switch on.
  4. Enter your address in Webhook endpoint URL. It must start with https://.
  5. Optional: enter a Webhook HMAC secret (up to 64 characters).
  6. Click Save Alerts & Webhooks.

Click Webhook Docs on the same tab for example messages.

Events you will receive

EventWhen it is sent
member_ringingThe group started ringing one of its members (a phone, extension or number).
bridgedA member answered and the caller was connected to them.
ring_group.completedThe Ring Group call finished.
transcription_completedThe call transcript is ready (only if transcription is turned on for the group).

On a busy group, you will usually receive several member_ringing events per call, one for each member that rings.

Example messages

A member's phone starts ringing

{
  "event": "member_ringing",
  "account_code": "295327",
  "group_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "call_uuid": "e5f6a7b8-c9d0-1234-ef01-345678901234",
  "leg_uuid": "f6a7b8c9-d0e1-2345-f012-456789012345",
  "destination_type": "pbx",
  "destination": "201",
  "priority": 1,
  "name": "Desk phone",
  "caller_id": "61400111222",
  "original_did": "61298786988",
  "ringing_at": "2026-06-07T23:15:02Z"
}

The call finishes

{
  "event": "ring_group.completed",
  "occurred_at": "2026-09-07T00:01:00Z",
  "account_code": "295327",
  "caller_id": "61400111222",
  "original_did": "61298786988",
  "ring_group": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Sales",
    "route_token": "rg_a1b2c3d4e5f6"
  },
  "call": {
    "uuid": "550e8400-e29b-41d4-a716-446655440004",
    "status": "completed",
    "started_at": "2026-09-07T00:00:00Z"
  }
}

The transcript is ready

{
  "event": "transcription_completed",
  "account_code": "295327",
  "group_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "call_uuid": "e5f6a7b8-c9d0-1234-ef01-345678901234",
  "transcript": "Hello, I was calling to check on the progress of our order.",
  "transcription_format": "plain",
  "transcription_model": "phone",
  "completed_at": "2026-06-07T23:19:30Z"
}
FieldWhat it means
call_uuidA unique ID for the call. Use it to link all events for one call.
leg_uuidA unique ID for one member's ring attempt. Links member_ringing to bridged.
destination_type / destinationWhat was rung, for example a PBX extension (pbx, 201).
nameThe member's friendly name from your Ring Group settings.
priorityThe member's ring order in the group.
ringing_at / answered_at / completed_atWhen each step happened (UTC).

If both the top-level and call section contain caller_id or original_did, use the top-level value.

Security

If you set a secret, each request includes:

X-CrazyRingGroup-Signature: <signature>
User-Agent: CrazytelRingGroups/1.0

Note that the Ring Groups signature is plain hexadecimal, without the sha256= prefix used by some other features. See Verifying webhook signatures.

Delivery and retries

  • Your server should reply with a 2xx status within 10 seconds.
  • If it does not, Crazytel tries again after 5 minutes, 15 minutes, 1 hour, 4 hours, then 12 hours. After 5 attempts the message is marked as permanently failed.
  • A call's activity shows Webhook queued and Webhook delivered entries.

Cost

Webhooks are included at no platform charge.

Need Help?