Custom Webhooks

You can use the following custom webhooks to use some advanced functionalities directly from any flow using the Webhook widget.

Before You Begin

• You need to be able to make HTTP Calls from your account. By default, we only allow HTTPS. Send a mail to [e-mail] to request to enable HTTP in your account.

• Whitelist your IP in Whitelist page.

• For Request parameters, you can use Store Variable widget.

• Method names are listed below

createOutbound

Using this webhook, you can request to initiate any Outbound Flow of your account using it's API.

http://192.168.1.42:3000/centraloutboundwebhook-v1/prod/

Request

Flow Variable	Example	Description
$flow.syskey.apiVersion	1.0	Outbound Flow Version
$flow.syskey.securityID	<64 Character UUID>	Security ID
$flow.syskey.flowID	<8 Chacter UUID>	Flow ID
$flow.syskey.clientID	123123123	Client Identifier
$flow.syskey.delayMinutes	0	When to start the Outbound Flow from current system time.
$flow.syskey.contactNumbers	91997974 6666	Customer Numbers

Response

Flow Variable	Value
$flow.key.obdResponseCode	200
$flow.key.obdReqID	Request ID
$flow.key.obdPhononUUID	Phonon UUID

shortURL

Using this webhook, you can shorten a long URL to a short URL.

https://s.phonon.in/UrlShortner/phonon/shortUrl

Direct

URL: https://s.phonon.in/UrlShortner/phonon/shortUrl

Method: POST

Headers:

Headers
Content-Type	application/json
Accept	application/json

Request:

{
	"custToken": "abcd1234",
	"longUrl": "https://google.co.in"
}

custToken is static at "abcd1234"

Response:

{
  "shortUrl": "https://s.phonon.in/BEK4YYnx"
}

You can have your custom domain. Contact Support to help you with that.

updateUserPreferences

Using this webhook, you can update $user.key Flow Variables without requiring a Make Call widget. Great for usage in Email and SMS flows. Note: This will become an inert feature of $user.key flow variables soon resulting this to be obsolete.

URL: http://192.168.50.21:3000/centraloutboundwebhook-v1/test/

Method: POST

Request

Flow Variable	Example	Details
$user.syskey.contactNumber	8000374XXX	Enter the unique ID of the Customer such as it's phone number.
$user.syskey.accountID	163	Account ID of the Central Account where the flow is
$user.key.XXXX...	Value	You can save or get any value

Response

updatePauseStatusForCLI - Change Break Status of a Direct Dial Agent

Using this webhook, you can change the break status of a Direct Dial Agent. While the Direct Dial Agent is on break, s/he will not be considered for any calls allotment. For example, if your Dialer DID is 91806880080, you can create an Inbound Flow with the same DID with this webhook. DD Agents can call on the Inbound number to change their pause status anytime (or you can toggle it automatically).

Notes:

1. In the Dialer Flow, you can get the Agent CLI using $call.agent.dnis.number or for Inbound Flow =>$call.cli.number

URL: http://192.168.60.15:3000/centraloutboundwebhook-v1/prod/

Method: POST

Request

Flow Variable	Example	Description
$flow.key.pause	true	Set the Direct Dial Agent Pause Status to be true. Mandatory
	false	Set the Direct Dial Agent Pause Status to be false. Mandatory
$flow.key.cli	9879964805	CLI of the Direct Dial Agent. With or Without Country CodeMandatory
	919879964805

Response

Flow Variable	Example	Description
$flow.key.cli_pause_update	true	The Direct Dial was successfully paused / unpaused
	false	The Direct Dial was could not be paused / unpaused

To Dos

1. Get the current status of a Direct Dial Agent

2. The reports for break visibility are under development.

3. Stress testing of the API is due.

XML in webhook -

Webhook Widget now supports the XML content type along with JSON to make it even more universal.

You can use XML in both Request Body as well as in Response mapping.

To do XML Response Mapping, read our XML Response Mapping guide here.

Zoom Webhook XML Widget.png