Create Callback Profiles

sid

String

Account SID (Security Identifier).

HXXXXXXX071IN

Yes

content-type

String

The format in which the data is sent.

application/json

Yes

api-key

String

API key generated from Kaleyra.io account.

Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3

Yes

title

String/Characters

The Callback Profile name.

• *Note**: It should respect the following conditions:
• Minimum three characters.
• Only alphabet, numbers, spaces, hyphens, and underscores are allowed.

Callback_Profile_Test_1

Yes

http_method

String

The method type you want to use for the Callback Profile that you are creating.
Allowed HTTP Methods are:

• GET
• POST
• PUT
• DELETE

POST

Yes

url

String

The endpoint on which you want to receive a callback. It could be HTTP or HTTPS.

https://webhook.site/dxxxxxx9-bxx8-4xx2-9xx5-4xxxxxxxxxx8

Yes

body

Object

For POST and PUT methods, you need to provide the callback body. It should be in JSON format.

The body is defined by the callback profile creator. For example, the callback profile created for the Default - No Channel Selected, Dynamic Variable is not defined by default, it has to configure based on the requirements.

{"name":"<name>"}

Yes

response_message

String

The message you want to send to a requester when the Payload is successful.
It is specific to chatbots and can be used only with chatbots. It may contain replacers.

For example, when a request is made for Chatbot and if the payload is successful then you can update the message like, Thank you, {"name": "first_name"} and in response, it will be:
Thank you, John, according to the database.

Thank you, {"name": "John"}

No

headers

Object

Add additional headers and corresponding values that will be added to the HTTP/HTTPS request sent to your configured endpoint when using this callback profile.

When a header is not specified as multipart/form-data, then by default it will consider the content-type asapplication/json and in the response, the user will not see the data in Form value instead of that they will view in JSON format.

{  
      "key1": "value1",  
      "key2":"value2"  
      }

No

enc

Object

Encryption Parameters must be specified when you want to encrypt callback parameters. Encrypt the callback data by using specified algorithms, keys, and IV details. Apart from these three mandatory parameters, you have Params which is an optional parameter. For more information, see Callback Encryption.

"enc": {  
      "algo": "AES-128-GCM",  
      "key": "1xxxxxxxxxxxxxx4", //16-bit long key  
      "IV": "3xxxxxxxxxxxxxx4" //16-bit long key  
      }

No

channel

String

Specify for which channel the callback profile is created. Possible value is "sms" or "Defatul - No Channel Selected". Default - No Channel Selected, can be used for creating a profile to be used for getting information related to any channels other than SMS, like WhatsApp, Email, and so on.

sms

No

events

Array

The event you want to add to the channel. When you create a callback profile for Default - No Channel Selected then it does not require events. You can put null for events, except for SMS. For SMS it is SMS-sent.

SMS-sent

No