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:

1. On the profile settings drop-down list, select the Callback Profiles option.

The Callback Profiles page appears.

2. Click Add New.
   The Add Callback Profile page appears.

3. In the Title field, enter the title of the Callback profile.

📘

Note:

You can use the Title field to search for callback profiles.

4. From the Select Channel API list, select Default—No channel selected.
5. From the HTTP Method dropdown list, select the POST method for your configured endpoint.
6. 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.
7. The request body must be configured as follows: {"workflowevent":""}.
8. 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:

The following table describes the different attributes of the result object:

The following table describes the different attributes of the channel1 and channel2 objects: