Create Email Callback Profiles with Dynamic Variables

You can create an Email callback profile within the Kaleyra.io user interface to get information about the Email delivery status. The wizard to set up the callback profile for the Email channel provides a list of dynamic variables specific to the Email channel that you can individually select to get the latest information about your email message that you are interested in.
After successfully creating an Email callback profile, you must use the ‘callback profile ID’ parameter in an Email API request (POST) to fetch the Email delivery information in an endpoint that you specify.

To create an Email callback profile:

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

The Callback Profiles page appears.

2. On the Callback Profiles page, click Add New.
   The Add Callback Profile window appears.

3. Perform the following steps to add all the relevant information in the ‘Add callback profile’ page.

   1. In the Title field, enter a title for the callback profile. This is a mandatory field.

      

   2. From the Select Channel API list, select the option ‘email - Email Gateway APIs’ to create a callback profile to be used to receive back updated information about the email status.

   3. Once you select the option ‘email - Email Gateway APIs’ in the previous step, the Events for the selected channel field is automatically set to the option ‘email-send’.

   4. In the HTTP Method field, select a method for which the callback is created.
      The options are: POST, GET, PUT, and DELETE.

      📘

      Note:

      Only the POST method supports the use of dynamic variables for the Email channel.

   5. In the Enter Endpoint field, enter the URL at which the callback information should be received.

   6. In the Dynamic Variables field, click View to view and select the dynamic variables for the selected channel. The dynamic variables represent all the possible information that you can retrieve about the email as part of the callback that kaleyra.io will send to your system. You may select all of them, or only the fields you are interested in.
      The List Dynamic Variables window appears.

In the List Dynamic Variables window,

• To select all the dynamic variables, click Select All or manually select the dynamic variables check-boxes that you want to receive in the callback sent from Kaleyra to your system.
• After selecting the variables, click Copy to Clipboard.
• Click ‘X’ (CLOSE) on the window to close the window.
• For POST method, using the mouse, right click and paste the dynamic variables in the Request Body field.

4. From the Retry drop-down, select the number of retries that Kaleyra Platform will perform in case the first callback receives a failure response or no response from your endpoint. You have the option for 0, 1, and 2. If you select either 1 or 2 retries, then you must enter the Time Interval in secs and the Timeout in milli-secs values. For assistance with more than two retry attempts, you can contact the Support team.

   📘

   Note:

   The following are the retries according to channels:

   • SMS - max 3 retries, 10s interval between retries.
   • WhatsApp - max 4 retries, 60s interval between retries.
   • Voice - max 4 retries, 60s interval between retries.
   • Email - max 4 retries, 60s interval between retries.

For the Default priority, the Time Interval increases exponentially after each failed attempt. The formula for the delay: Delay = Initial Delay×(2^retry_count).

If the initial delay is 60 seconds and we allow up to 2 retries:

5. Click Next.
   The Advanced Configuration step appears.

6. Perform the following:

   1. (Optional) From the Data Format drop-down, select one of the following options:
      • Form Data - To view the callback data through fields.
      • URL Encoded - To view the callback data in URL encoded format. The UEL encoded data can be replaced using special characters and spaces in data with a format that can be transmitted over the internet using URLs.
      • JSON - To view the data in JSON format. JSON is a lightweight data format used to store and exchange data between a client (like a browser) and a server.
   2. In the Header field, enter values as Key-Value pairs.
      Use the Header fields to include additional information on the HTTPS request generated by Kaleyra for your system.
      • Use the Headers field for authentication purposes. For example: API-KEY-based authentication or Basic authentication. For more information on basic authentication, see Basic Authentication.
      • Use the Headers field to indicate how the callback response should be presented using the “Content Type”.
   3. Click the Enable Encryption toggle button. The fields related to encryption are displayed. This is an optional field. The Algorithm, Key, Initialization Vector, and Parameters fields appear. To know more about these fields, see Callback Encryption.

7. Click Save.
   The confirmation message appears and the callback gets listed to the Callback Profile page.

   

The following table shows the field descriptions on the Add Callback profile window.

The following table shows the dynamic variables for Email channel and their descriptions with examples.

Email delivery statuses

The following table shows the Email delivery statuses and their descriptions.