Callback Profile for Fallback Flow
Using the 'Callback Profiles' feature, you can receive essential information and updates about various aspects of the Fallback Flow. The Fallback result will be sent using a callback once the flow is completed.
This document will guide you through creating callback profiles for Fallback flows.
Creating a Callback Profile for Fallback Flow
To create a callback profile, perform the following steps:
- On the profile settings drop-down list, select the Callback Profiles option.
The Callback Profiles page appears.
- Click Add New.
The Add Callback Profile page appears.
- In the Title field, enter the title of the Callback profile.
Note:You can use the Title field to search for callback profiles.
- From the Select Channel API list, select Default—No channel selected.
- From the HTTP Method dropdown list, select the POST method for your configured endpoint.
- In the Enter Endpoint textbox, enter the webhook URL where you want to receive the callback calls. Ensure that the endpoint is available over the public internet.
- The request body must be configured as follows: {"workflowevent":"
<placeholder>"}. - Click Save to save the callback profile in your kaleyra.io account.
The saved profiles are listed on the Callback Profile page. You can filter the data on the listing page with Callback Profile Name, HTTP Method, and Created Date range for accurate results.
Note:Each Callback profile created has a unique ID (as shown in the following image) that is used in the Fallback Flow to trigger the callback.
Sample Callback Response
{
"workflowInvocationId": "4AhJXi67XXXXXXXXXXFyQT ",
"executionStatus": "COMPLETED",
"timestamp": "2024-05-24T16:18:01.379310507Z",
"result": {
"channel1": {
"createdAt": "2024-05-24T16:17:51.479884794Z",
"from": "wasender",
"to": "919620838XXX",
"messageId": "9db24eba-eeae-41be-97a5-3ac45551ec1b",
"clientMessageId": "0f6da8f1-923d-4995-a274-4830d09d8287",
"channel": "whatsapp",
"statusCode": "TIMEOUT",
"timeout": "PT5S"
},
"channel2": {
"createdAt": "2024-05-24T16:18:01.126686174Z",
"from": "smssender",
"to": "919620838XXX",
"messageId": "5599165f-3122-474f-8298-4177a24e326a",
"clientMessageId": "e66aa985-6587-42d5-81e5-4e32b37a5252",
"channel": "sms",
"statusCode": "DELIVERED",
"channelMessageId": "83c09c45-240d-4aae-95ae-5925f82e86ea:1",
"statusDetails": "Delivered: DELIVRD: Message Delivered",
"acceptedAt": "2024-05-24T16:18:00.463204465Z"
}
}
}Response Parameters and Description
The following table contains the details of the parameters you receive in the Callback response:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
workflowInvocationId | String | A unique internal invocation ID is assigned when the invocation is requested. | 4AhJXi67XXXXXXXXXXFyQT |
executionStatus | String | The Callback is sent only when the execution status is COMPLETED, indicating that the workflow has successfully executed and reached its final state. | COMPLETED |
timestamp | String | Timestamp when the response was created. | 2024-05- 24T16:18:01.379310507 Z |
result | JSON object | This object contains the channel information. | See the specific table for details. |
The following table describes the different attributes of the result object:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
channel1 | JSON object | This object contains the callback information of channel1. | See the specific table for details. |
channel2 | JSON object | This object contains the callback information of channel2. | See the specific table for details. |
The following table describes the different attributes of the channel1 and channel2 objects:
Parameter | Data Type | Description | Example |
|---|---|---|---|
| String | A unique internal invocation ID is assigned when the invocation is requested. | 4AhJXi67XXXXXXXXXXFyQT |
| String | The Callback is sent only when the execution status is COMPLETED, indicating that the workflow has successfully executed and reached its final state. | COMPLETED |
| String | Timestamp when the response was created. | 2024-05- 24T16:18:01.379310507 Z |
| String | Timestamp when the receipt was created. It is not the same as the created_at timestamp that you can find in the channel’s logs. | 2024-05- 24T16:17:51.479884794 Z |
| String | Sender used to send the message (for example, SenderID for SMS, Display Name for WhatsApp). | wasender |
| String | A unique ID of the recipient used for that channel. For example, the mobile number to which SMS or WA messages have been sent. | 919620838XXX |
| String | Internal message ID at Fallback application level. | 9db24eba-eeae-41be-597a5-3ac45551ec1b |
| String | Globally unique Client Message ID that the caller has to set. | 0f6da8f1-923d-4995- a274-4830d09d8287 |
| String | The channel this message receipt refers to (for example, whatsapp, sms). | |
| String | A normalized, channel-agnostic status code to which channel-specific status codes are mapped. Possible values include:
| TIMEOUT |
| String | Channel Message ID that can be found in the channel log. | 83c09c45-240d-4aae-595ae-5925f82e86ea |
| String | The actual status and status trace received by the channel. This is applicable only for statusCodes received from the channel. | Delivered: DELIVRD: Message Delivered |
| String | Timestamp indicating when the message was accepted by the service responsible for submitting it to the channel. This is applicable only for statusCodes received from the channel. | 2024-05- 24T16:18:00.463204465 Z |
Updated 13 days ago