...
Outcome : Everytime the flow is executed, all the flow details (ex- phonon UUID, request ID, CLI number, flow variables etc) will be send to the default webhook selected.
...
Note :
If you want to send some additional data at the end of the flow in some different format, then you can use a webhook widget after ‘on flow complete’ widget.
This functionality will be modified in the near future.
Internal Webhook
Custom webhooks are internal webhooks which can be used to pass on the data in between the flow execution.
...
Go to Advanced → Webhook page
Click on ‘add webhook’
Select the method as ‘Post’
Enter or paste the URL of the webhook
Select the authentication method and click on the ‘check button’ .Once you see a green tick beside check button, select the authentication methodto verify.
None : If there is no authentication required
Basic : If username and password is required
Select the body type as ‘None’ and click on save button.
...
To know more about webhook methods, you can visit here.
Make sure your HTTP usage is enabled for your account. If not, then you can send a mail to request for the same on support@phonon.io
Make sure to whitelist your IP in the whitelist section of your account
Once any specific method is called, the response of values will be mentioned appeared in the mentioned specified response variables.
Examples of
...
Internal Webhook
1. Initiate Outbound Flow
Using this webhook, you can request to initiate any Outbound Flow of your account using it's API.
URL : http://192.168.1.42:3000/centraloutboundwebhook-v1/prod/
Method : createOutbound
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 |
2. shortURL
Using this webhook, you can shorten a long URL to a short URL.
URL: https://s.phonon.in/UrlShortner/phonon/shortUrl
Method: POST
Headers:
Headers | Title |
Content-Type | application/json |
Accept | application/json |
Request:
Code Block |
---|
{
"custToken": "abcd1234",
"longUrl": "https://google.co.in"
} |
custToken is static at "abcd1234"
Response:
Code Block |
---|
{
"shortUrl": "https://s.phonon.in/BEK4YYnx"
} |
You can have your custom domain. Contact Support to help you with that.
3. 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 :
4. 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. DID Agents can call on the Inbound number to change their pause status anytime (or you can toggle it automatically).
Notes:
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 |
| Set the Direct Dial Agent Pause Status to be true. |
Content |
| Set the Direct Dial Agent Pause Status to be false. |
$flow.key.cli | 9879964805 | CLI of the Direct Dial Agent. With or Without Country Code |
Content | 919879964805 | Content |
Response :
Flow Variable | Example | Description |
$flow.key.cli_pause_update |
| The Direct Dial was successfully paused / unpaused |
Content |
| The Direct Dial was could not be paused / unpaused |