Callback Profiles

Callback profiles are used to trigger the endpoints and receive callback data for the configured callback event. Use the Callback Profiles page, to create new callback profiles, and edit or delete the existing callback profiles.

Create a Callback profile

To create a callback profile:

  1. Navigate to Settings. The Setting page appears.
  2. Click Callback Profiles. The Callback Profiles page appears.
  3. Click Create New.

  1. In the Name field, enter the name of the Callback profile.
  2. From the HTTP Method dropdown list, select the required method.

  1. Based on the selection, do the following:
HTTP MethodDescriptionStepsSample
GETUse the GET method to retrieve information from the given server using a given URI.1. Enter the URL to trigger.
2. Enter the required headers as a key/value pair.
{
"data": [
{
"url": "https://webhook.site/93e95c0d-53eb-4960-b628-6a03cb672946

",
"http_method": "get",
}
]

}
POSTUse the POST method to send data to the server.1. Enter the URL to trigger.
2. Enter the required headers as a key/value pair.
3. Provide the body in any one of the four body types—XML, JSON, HTML, or Text.
{
"data": [
{
"url": "https://webhook.site/93e95c0d-53eb-4960-b628-6a03cb672946

",
"http_method": "post",
"body":{
"name":"Ray","phone":"<whatsapp_number>","address":{"formatted_address":"<address.formatted_address>"
}
}
]
}
PUTUse the PUT method to replace all current representations of the target resource with the uploaded content.1. Enter the URL to trigger.
2. Enter the required headers as a key/value pair.
3. Provide the body in JSON.
{
"data": [
{
"url": "https://webhook.site/93e95c0d-53eb-4960-b628-6a03cb672946

",
"http_method": "post",
"body":{
"name":"Ray" }
}
]
DELETEUse the DELETE method to remove all current representations of the target resource given by a URI.1. Enter the URL to trigger.
2. Enter the required headers as a key/value pair.
{
"data": [
{
"url": "https://webhook.site/93e95c0d-53eb-4960-b628-6a03cb672946",
"http_method": "delete",

}
]
}

  1. Click the Enable Encryption toggle button. The fields related to encryption are displayed.

📘

Note

  1. Enter the following details to enable encryption:
FieldDescription
AlgorithmSelect the required algorithm from the list:
- AES-128-CFB
- AES-128-GCM
- AES-192-CFB
- AES-192-GCM
- AES-256-CFB
- AES-256-GCM

Note:
- GCM (Galois counter mode)—GCM encryption algorithm combines two modes; the counter mode and the new Galois mode of authentication. The parallel computation enabled in the latest mode ensures higher-speed encryption with higher throughput than other encryption algorithms like CFB.
- CFB (Ciphertext feedback)—CFB algorithms can only be parallelized in the decryption process and not in the encryption process, therefore they run with a slower performance than other algorithms such as those in mode GCM.
KeyEnter a unique secret key to be passed along to the algorithm for encryption.

Note:
The length of the key is dependent on the algorithm selected, the options are:
- AES-128 (Length will be 16 characters)
- AES-192 (Length will be 24 characters)
- AES-256 (Length will be 32 characters)
Initialization VectorEnter the initialization vector of 16 characters.

Note:
- Initialization Vector is used to prevent a sequence of text that are identical from generating the same ciphertext when encrypted.
- This is a mandatory factor.
ParametersEnter the parameters to be encrypted.

  1. Click Save. 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 APIs to trigger the callback.

Callback Reports

Kaleyra.io enables you to get automated Callback reports through mail. If you enable the callback report then you get a mail with the count of all failed and delivered callbacks within the selected timeframe.

You have the option to enable the Callback Report from the Notification page in Settings. After successfully enabling the Callback Report, you get the email based on the selected frequency (daily, weekly, or monthly).

Enable Callback Reports

You can enable the Callback Report from the Kaleyra.io platform. To enable Callback Report:

  1. Sign in to your Kaleyra.io account.
  2. On the Channels page, click User Account > Settings.
  3. On the Notification tab, turn on the Callback Report toggle.
  4. The Frequency details appear. Select the required report frequency from the following options:
    Daily—The email is sent every day at 5:00 PM (based on the company timezone).
    Weekly—The email is sent every Wednesday of the week (based on the company timezone).
    Monthly—The email is sent every 25th of the month(based on the company timezone).
  5. When you select the required frequency option, the Email Addresses textbox appears. Enter the email address you wish to send Callback Reports to. If you want to enter multiple email addresses, ensure that they are comma-separated.
  6. Click Save to save the settings. A success message is displayed. The updated email address gets notifications about the configured frequency.

📘

Note:

You can select more than one Report Frequency.


What’s Next