Kaleyra SMS Integration with Braze

SMS Plugin

This page covers the following topics:

Prerequisite

You must have an active Kaleyra account to use the Kaleyra SMS plugin with Braze. To register a new account on K.io, contact our support team. See: Support

Adding Kaleyra SMS as a Template

To add Kaleyra SMS as a template, perform the following steps:

  1. Create a new template on the Webhook Template Editor.
  • On the navigation bar, click the Campaigns tab under Engagement to access the Webhook template.
  • Click on the Templates and Styles tab to access the Webhook Template Editor. You can now create a new template.
  1. Customize Your Template.
    You can customize your template using the following options:
  • Enter a unique template name such as Kaleyra SMS
  • Enter the webhook URL
  • Enter the Request Body
  • Add Request Headers
  • Select the HTTP Method
  1. Test Your Template.
    To view the Webhook preview before sending it to the end-users. You can send a test Webhook through the Settings tab in the top right corner.

  2. Save Your Template.
    Click Save Template to save your template in the bottom right corner of the editor. Now you can use this template in any campaign of your choice.

Adding Kaleyra SMS as a Webhook in Campaign or Canvas

To add Kaleyra SMS as a Webhook in Campaign or Canvas, perform the following steps:

  1. Set Up a Webhook.
    Add a new webhook message to a Campaign or Canvas. You can then choose to build a webhook from scratch or use one of the existing Kaleyra SMS Templates.

  2. Enter the Webhook URL.

📘

Example URL:

https://api.kaleyra.io/v1/SID/messages

  1. Add the SID (Security Identifier) in the above request from your Kaleyra account. For more information on generating an API key, see Generating an API key and SID. To view the API Key and the SID, see View API Key and SID.

  2. Create the Request Body using the JSON key-value pairs option.

KeyValue
to{{phone}}
senderRegistered Sender ID
body{{body}}
sourceBraze
typeIndian Customer - Use one of the following: OTP, MKT, or TXN.
Non-Indian Customers - Use Default.
template_id (India only)2xxxxxxxxxxxx
  1. Add Request Headers and HTTP Method.
KeyValue
api-keyAc4XXXXX21f
Content-Typeapplication/x-www-form-urlencoded

📘

Note:

Set HTTP method as POST.

  1. Continue Campaign Creation.
    Using all the message types, you can preview how the request appears for a particular user, random user, or user with specific attributes in the preview section of the webhook composer.