Globalex — Webhook API Reference

Webhook Payload Reference

All template variables available in webhook payloads, organized by trigger event. Use {{fieldName}} syntax in your payload template to inject real call data. Available fields are not added to every request automatically; select them in the provider endpoint mapping to include them in that endpoint's payload.

Formats: a webhook can be sent as JSON or XML, by POST or GET (with GET the fields go in the query string).

Primary Syntax

{
  "caller": "{{calleridnum}}",
  "extension": "{{extension}}",
  "direction": "{{direction}}",
  "duration": "{{duration}}"
}

Alternative Syntax

{
  "callId": "{call.uniqueid}",
  "phone": "{call.calleridnum}",
  "apiKey": "{client.apiKey}",
  "org": "{call.org_name}"
}

CDR Full Example

{
  "event": "call_ended",
  "caller": "{{calleridnum}}",
  "endtime": "{{endtime}}",
  "result": "{{disposition}}",
  "ivr_selection": "{{ivr_digit}}",
  "callback_caller": "{{callback_caller_number}}",
  "callback_number": "{{callback_number}}",
  "recording": "{{recording_url}}"
}

XML Example

<call>
  <caller>{{caller_number}}</caller>
  <dialed>{{did_number}}</dialed>
  <extension>{{answeringExtension}}</extension>
  <queue>{{queueName}}</queue>
  <status>{{disposition}}</status>
  <recording>{{recording_play_url}}</recording>
</call>

Pick a trigger event from the sidebar to start building its payload — the fields available differ per event.

Field Name	Description	Example Value	Available In
{{digit}}	Completed DTMF digit; on CDR this is the latest accumulated main-IVR selection	5	Cdr, DTMF
{{dtmf_application}}	Dialplan application active when the digit was received · not on every call	Read	DTMF
{{dtmf_context}}	Dialplan context active when the digit was received · not on every call	client.voip-ivr-171	DTMF
{{dtmf_scope}}	Purpose classification for this digit · not on every call	ivr_menu	DTMF
{{input_compNum}}	What the caller typed, collected as compNum · not on every call	3500	Cdr, Hangup, IVRInput
{{ivr_input_1}}	First input collected on the call · not on every call	3500	Cdr, Hangup, IVRInput
{{ivr_input_1_name}}	Name of the first collected input · not on every call	compNum	Cdr, Hangup, IVRInput
{{ivr_input_2}}	Second input collected on the call · not on every call	43434547	Cdr, Hangup, IVRInput
{{ivr_input_2_name}}	Name of the second collected input · not on every call	empNum	Cdr, Hangup, IVRInput
{{ivr_input_3}}	Third input collected on the call · not on every call	—	Cdr, Hangup, IVRInput
{{ivr_input_count}}	How many inputs were collected on the call · not on every call	2	Cdr, Hangup, IVRInput
{{ivr_input_last}}	Most recent collected input on the call · not on every call	43434547	Cdr, Hangup, IVRInput
{{ivr_input_last_name}}	Name of the most recent collected input · not on every call	empNum	Cdr, Hangup, IVRInput
{{ivr_input_name}}	Input variable used by Read(), when applicable · not on every call · also: dtmf_input_variable	phone_num	IVRInput
{{ivr_input_value}}	Value the caller finished typing at a Read() prompt · not on every call	43434547	IVRInput
{{ivr_inputs_json}}	All collected inputs as JSON · not on every call	{"compNum":"3500","empNum":"43434547"}	Cdr, Hangup, IVRInput
{{ivr_inputs_text}}	All collected inputs as text · not on every call	compNum=3500;empNum=43434547	Cdr, Hangup, IVRInput
{{call_id}}	Same id on every leg of the call. Use it to match ring, answer and end of call	1763328773.117048	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{channel}}	AMI channel name	SIP/201_globalex.co.il-0000d856	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{destinationchannel}}	Channel of the answering party · not on every call	SIP/201_globalex.co.il	Cdr
{{uniqueid}}	Unique call ID	1763328773.117048	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{caller_number}}	Caller phone number · also: calleridnum, src, source	0521234567	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{callerid1}}	Caller id of the first bridged channel · not on every call	0521234567	Answer
{{callerid2}}	Caller id of the second bridged channel · not on every call	201	Answer
{{calleridname}}	Caller name (if sent by trunk) · not on every call	John Doe	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF
{{connectedlinename}}	Connected party name · not on every call	Extension 201	Begin, Ring, Ringing, Answer, Hangup
{{connectedlinenum}}	Connected party number · not on every call	201	Newchannel, Begin, Ring, Ringing, Answer, Hangup
{{destination}}	Destination number (CDR field) · also: dst, dest_number	SIP/201_globalex.co.il	Cdr, Begin, Ring, Ringing, Answer, Hangup
{{destinationcontext}}	Dialplan context the call ended in, so the routing path	from-internal	Cdr
{{extension}}	Extension (raw from AMI) · not on every call · also: exten	036760602	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{did_number}}	DID number (inbound) · not on every call · also: did, DID_number	031234567	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{call_direction_numeric}}	Call direction numeric (1=inbound 2=outbound 3=internal) · not on every call	1	Cdr
{{cause}}	Hangup cause code (AMI numeric)	16	Hangup
{{cause_text}}	Hangup cause description · not on every call	Normal Clearing	Hangup
{{cause-txt}}	Hangup cause in words	Normal Clearing	Hangup
{{dialstatus}}	ANSWER, NOANSWER, BUSY or CONGESTION · not on every call	—	Begin
{{direction}}	Call direction · also: call_direction	inbound	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF
{{disposition}}	Call result	ANSWERED/NO ANSWER/BUSY/FAILED	Cdr
{{fromout}}	Inbound from outside (1=yes) · not on every call	1 = מחוץ, ריק = פנימי	Cdr
{{toout}}	Outbound to outside (1=yes) · not on every call	1 = לחוץ, ריק = פנימי	Cdr
{{answer_time}}	When the call was answered · not on every call	2025-11-19 08:52:40	Answer
{{answertime}}	Answer time (datetime) · not on every call	2025-11-16 23:32:53	Cdr
{{begin}}	Start of the digit press	Yes	DTMF
{{duration}}	Total call duration (seconds)	201	Cdr
{{end}}	End of the digit press	No	DTMF
{{endtime}}	Call end time (datetime)	2025-11-16 23:36:14	Cdr
{{starttime}}	Call start time (datetime)	2025-11-16 23:32:53	Cdr
{{starttime_unix}}	Call start time (Unix timestamp) · not on every call	1747058343	Cdr
{{talk_time}}	Billable seconds (after answer) · also: billableseconds, billsec	201	Cdr
{{timestamp}}	When the event was processed, server time	2025-11-19 08:52:34	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{announcementName}}	Auto-announcement name · not on every call	Welcome Announcement	Cdr, Hangup, IVRInput
{{applicationNumber}}	Application / queue number · not on every call	801	Cdr, Ring, Answer
{{applicationType}}	Application type (Queue / RingGroup / IVR / Voicemail) · not on every call	Queue	Cdr
{{ivrName}}	IVR name · not on every call	Main IVR	Cdr, IVRInput
{{ivrNumber}}	IVR number · not on every call	600	Cdr
{{queueName}}	Queue name · not on every call · also: queue, Queue	801	Cdr, Begin, Ring, Ringing, Answer, Hangup, DTMF
{{ringGroupName}}	Ring group name · not on every call · also: ringgroup, RingGroup	701	Cdr, Begin, Ring, Ringing, Answer, Hangup
{{scenario}}	Routing scenario (Dial / Queue / RingGroup / IVR) · not on every call	Queue	Cdr
{{voicemailBox}}	Voicemail box · not on every call	201	Cdr
{{callback_caller_number}}	Original caller number that requested the callback · not on every call	0541234567	Cdr
{{callback_number}}	Requested callback destination number · not on every call · also: callback_requested_number	0551234567	Cdr
{{callback_queue}}	Callback queue captured from the dialplan, when available · not on every call	710	Cdr
{{callback_requested}}	Whether the completed call entered the callback-request flow · not on every call	true	Cdr
{{recording_available}}	Recording available (true / false) · not on every call	true	Cdr
{{recording_download_url}}	Recording download URL · not on every call	https://voip1.globalex.co.il/API/download-file.php?fileid=...	Cdr
{{recording_filename}}	Recording filename · not on every call	IN201-20251119-085234-1763328773.117048.wav	Cdr
{{recording_play_url}}	Recording URL (stream/playback) · not on every call · also: recording_url	https://voip1.globalex.co.il/API/play.php?fileid=...	Cdr
{{userfield}}	CDR user field — raw recording path · not on every call	IN201-20251119-085234-1763328773.117048	Cdr
{{callerid}}	Displayed Caller ID for outbound calls	"Company" <0501234567>	Cdr
{{outbound_callerid}}	Outbound Caller ID (from Hangup / NewCallerid event) · not on every call	0501234567	Cdr
{{outboundCallerId}}	Caller id shown on the outbound leg · not on every call	0501234567	Answer
{{client_id}}	Client ID (numeric)	5	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{ipaddr}}	IP the call came from, when the PBX reports it · not on every call	46.31.97.50	Cdr
{{org_name}}	Organization domain name · also: organization, domain	globalex.co.il	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{server_address}}	Server hostname · also: ServerAddress, ServerAdress	voip1.globalex.co.il	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{server_id}}	Server ID (1–12) · also: serverId	2	Cdr, Newchannel, Begin, Ring, Ringing, Answer, Hangup, DTMF, IVRInput
{{trunk_name}}	Trunk the call came in on or went out through · not on every call	GLX1	Newchannel, Ring, Answer, Hangup, DTMF, IVRInput
{{accountcode}}	Account code · not on every call	—	Cdr, Newchannel, Hangup
{{amaflags}}	Asterisk billing flag	DOCUMENTATION	Cdr
{{answeringExtension}}	Extension that actually answered the call · not on every call · also: answered_extension, answering_extension	201	Cdr, Answer, Hangup
{{bridgestate}}	Link or Unlink · not on every call	Link	Answer
{{bridgetype}}	Bridge type · not on every call	core	Answer
{{callType}}	inbound, outbound, internal, inbound-sim or outbound-sim · not on every call	inbound-trunk	Newchannel
{{channel1}}	First channel of the bridge · not on every call	SIP/019land-2-0000d856	Answer
{{channel2}}	Second channel of the bridge · not on every call	SIP/201_globalex.co.il-0000d857	Answer
{{channelstate}}	Asterisk numeric channel state	4	Newchannel, Ring, Ringing, Answer
{{channelstatedesc}}	Channel state in words: Ring, Ringing, Up	Ring	Newchannel, Ring, Ringing, Answer
{{class}}	Music on hold class · not on every call	default	DTMF
{{context}}	Asterisk context	from-internal	Cdr, Newchannel, Begin, Ring, Answer, Hangup, DTMF
{{dcontext}}	Destination context (CDR destinationcontext) · not on every call	globalex.co.il-ext-queues	Cdr
{{destuniqueid}}	Uniqueid of the leg being dialled · not on every call	1763328773.117049	Begin
{{dialstring}}	What Asterisk dialled · not on every call	SIP/201_globalex.co.il	Begin, Ring, Ringing
{{lastapp}}	Last Asterisk application · not on every call	Dial	Cdr
{{lastapplication}}	Last application (CDR direct field)	Dial	Cdr
{{lastdata}}	Last application data / arguments	SIP/201_globalex.co.il,300,	Cdr
{{subevent}}	Begin or End	Begin	Begin
{{transfertype}}	Blind or attended · not on every call	Blind	DTMF
{{uniqueid1}}	Uniqueid of the first bridged channel · not on every call	1763328773.117048	Answer
{{uniqueid2}}	Uniqueid of the second bridged channel · not on every call	1763328773.117049	Answer
{{call_leg_type}}	Leg type (sip / local_1 / local_2) · not on every call	sip	Cdr, Hangup
{{call_origin}}	Call origin (webcall / callback / direct) · not on every call	webcall	Cdr, Hangup
{{is_webcall}}	WebCall flag (1=yes, 0=no) · not on every call	0	Cdr, Hangup
{{webcall_user}}	WebCall username (from accountcode) · not on every call	webdial1	Cdr

Sample Payload — All Triggers

Add a fixed field: