Versions Compared

Old Version 3

changes.mady.by.user Riddhi Shah (Deactivated)

Saved on

compared with

New Version 4

changes.mady.by.user Abhinandan Shah (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Content

Table of Contents

Introduction

Webhooks are used to communicate between two different or same systems. You can use webhooks when you want central to send/receive any data from/to other systems. On Central, you can operate webhooks in 3 different manner, which are as follows -

Webhook for flow

On flow complete webhooks are used when you want to push/send all the flow details to the default webhook once the flow gets completed.

In order to send the details on flow complete, you need to follow below steps -

Step 1 : Configure webhook

First step is to configure a webhook(to which the details will be send) and set it as ‘default webhook’. To configure a webhook, you can follow below steps -

  1. Go to Advanced → Webhook page

  2. Click on ‘add webhook’

  3. Select the method as ‘Post’

  4. Enter or paste your external webhook URL and click on ‘check button’.

  5. Once you see a green tick beside check button, select the authentication method.

    1. None : If there is no authentication required

    2. Basic : If username and password is required

  6. Select the body type as ‘None’.

  7. Enable ‘Is default webhook' and click on save button.

Step 2 : Enable webhook in flow

Open the ‘Details section’ of the flow for which you want to send details to the webhook.

Enable ‘webhook for the flow’ and done. After ever execution of this flow, all the flow details will be send to the default webhook in the predefined format.

Predefined Format :

Code Block
{	
    "callDetails": [
		{
			"calleeNumber": "Phone number of the callee",
			"connectTime": "Timestamp of call when started",
			"didNumber": "DID used in call",
			"duration": "Total Call duration in seconds",
			"endTime": "Timestamp of call when ended",
			"hangupCause": "Hangup cause code of the call",
			"incoming": True if the call was incoming false otherwise,
			"startTime": "Timestamp of call when started"
		}
	],
	"keys": [
		{
			"name": "$flow.key.variable1",
			"value": "value of variable"
		},
		{
			"name": "$flow.key.variable2",
			"value": "value of variable"
		} // This will be repeated for all the variables passed during the call
		
	],
	"phonon-uuid": "Phonon uuid of the call",
	"recordingUrls": [
		{
			"recordedFileName": "file name of the recording",
			"recordedFilePublicPath": "URL of the recording, where it is stored"
  }
  ]
  }

Outcome : Everytime the flow is executed, all the flow details (as mentioned in the format) will be send to the default webhook selected.

Note :

  1. 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.

  2. This functionality will be modified in the near future.Internal Webhooks: Use any of the pre-made internal functions. Use this when you need to use any of the commonly used functions.

  3. Webhook Widget: Call any external API using dynamic data and configurable structure. Use this when you want to integrate and use any external API

  4. Flow End Webhook: Call the default external webhook for any flow. Use this when you need to push flow details on a particular webhook.

    Status
    titleTo be deprecated

Internal Webhook

Custom webhooks are internal webhooks which can be used to pass on the data in between the flow execution.

...

You do not need to bother about the request body or need to specify the variables that needs to be passed. You can simply follow the 2 steps to invoke any webhook in between the flow.

Step 1 : Configure Internal Webhook

First step is to configure a webhook(to which the details will be send). To configure a webhook, you can follow the below steps -

  1. Go to Advanced → Webhook page

  2. Click on ‘add webhook’

  3. Select the method as ‘Post’

  4. Enter or paste the URL of the internal webhook that you need to call/invoke from the list below

  5. Select ‘none’ in the authentication method

  6. Select the body type as ‘None’ and click on save button.

Step 2 : Save Variable (Optional)

If you want to provide any parameters then first you can store that parameter in any flow variable using operation widget (General Assignment Method). This step is completely optional.

Step 3 : Select configurations

In the webhook widget, you need to perform following configurations -

  1. Select URL : Once you have configured the webhook, you will be able to see that URL in the webhook widget. Select the URL of the webhook that you need to invoke.

  2. Enter Method : Enter the name of the method that you need to call

  3. Select Parameters : Select the parameters that you want to pass. Query parameters are the type of variables that will be passed based on the method selected. You can select multiple parameters.

    1. Call : All the variables of ‘call type’ ($call.cli, $call.state, $call.start etc)

    2. $flow.key : All the variable of type ‘$flow.key’ ($flow.key.<keyname>) will be passed

    3. $user.key : All the user key variables will be passed ($user.key.<keyname>) will be passed. To know more about variables, you can click here.

  4. Document API : You can use this area to document your API that is you can explain or provide some insights of the purpose of this webhook call/API. This is an optional field.

Note :

  1. 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

  2. Make sure to whitelist your IP in the whitelist section of your account

  3. Once any specific method is called, the values will be appeared in the specified response variables.

List of Internal Webhook

List of Internal Webhook

You can use any of the following internal functions. How to configure them is listed below.

1. Initiate Outbound Flow

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

...

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.

...

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.

...

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).

...

Flow Variable

Example

Description

$flow.key.cli_pause_update

true

The Direct Dial was successfully paused / unpaused

Content

false

The Direct Dial was could not be paused / unpaused

How to Configure

First step is to configure a webhook(to which the details will be send). To configure a webhook, you can follow the below steps -

  1. Go to Advanced → Webhook page

  2. Click on ‘add webhook’

  3. Select the method as ‘Post’

  4. Enter or paste the URL of the internal webhook that you need to call/invoke from the list below

  5. Select ‘none’ in the authentication method

  6. Select the body type as ‘None’ and click on save button.

Step 2 : Save Variable (Optional)

If you want to provide any parameters then first you can store that parameter in any flow variable using operation widget (General Assignment Method). This step is completely optional.

Step 3 : Select configurations

In the webhook widget, you need to perform following configurations -

  1. Select URL : Once you have configured the webhook, you will be able to see that URL in the webhook widget. Select the URL of the webhook that you need to invoke.

  2. Enter Method : Enter the name of the method that you need to call

  3. Select Parameters : Select the parameters that you want to pass. Query parameters are the type of variables that will be passed based on the method selected. You can select multiple parameters.

    1. Call : All the variables of ‘call type’ ($call.cli, $call.state, $call.start etc)

    2. $flow.key : All the variable of type ‘$flow.key’ ($flow.key.<keyname>) will be passed

    3. $user.key : All the user key variables will be passed ($user.key.<keyname>) will be passed. To know more about variables, you can click here.

  4. Document API : You can use this area to document your API that is you can explain or provide some insights of the purpose of this webhook call/API. This is an optional field.

Note :

  1. 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

  2. Make sure to whitelist your IP in the whitelist section of your account

  3. Once any specific method is called, the values will be appeared in the specified response variables.

Custom Webhook Widget

Flow End Webhook

On flow complete webhooks are used when you want to push/send all the flow details to the default webhook once the flow gets completed.

In order to send the details on flow complete, you need to follow below steps -

Step 1 : Configure webhook

First step is to configure a webhook(to which the details will be send) and set it as ‘default webhook’. To configure a webhook, you can follow below steps -

  1. Go to Advanced → Webhook page

  2. Click on ‘add webhook’

  3. Select the method as ‘Post’

  4. Enter or paste your external webhook URL and click on ‘check button’.

  5. Once you see a green tick beside check button, select the authentication method.

    1. None : If there is no authentication required

    2. Basic : If username and password is required

  6. Select the body type as ‘None’.

  7. Enable ‘Is default webhook' and click on save button.

Step 2 : Enable webhook in flow

Open the ‘Details section’ of the flow for which you want to send details to the webhook.

Enable ‘webhook for the flow’ and done. After ever execution of this flow, all the flow details will be send to the default webhook in the predefined format.

Predefined Format :

Code Block
{	
    "callDetails": [
		{
			"calleeNumber": "Phone number of the callee",
			"connectTime": "Timestamp of call when started",
			"didNumber": "DID used in call",
			"duration": "Total Call duration in seconds",
			"endTime": "Timestamp of call when ended",
			"hangupCause": "Hangup cause code of the call",
			"incoming": True if the call was incoming false otherwise,
			"startTime": "Timestamp of call when started"
		}
	],
	"keys": [
		{
			"name": "$flow.key.variable1",
			"value": "value of variable"
		},
		{
			"name": "$flow.key.variable2",
			"value": "value of variable"
		} // This will be repeated for all the variables passed during the call
		
	],
	"phonon-uuid": "Phonon uuid of the call",
	"recordingUrls": [
		{
			"recordedFileName": "file name of the recording",
			"recordedFilePublicPath": "URL of the recording, where it is stored"
  }
  ]
  }

Outcome : Everytime the flow is executed, all the flow details (as mentioned in the format) will be send to the default webhook selected.

Note :

  1. 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.

  2. This functionality will be modified in the near future.

FAQs