POST Create New Callback
Set up a new callback for your API-Key.
This endpoint allows you to create a new callback for your requesting API Key.
Headers
API-Key
string
The API-Key that was provided for your account
API-Token
string
The API-Token used when the session was created
API-Timestamp
string
UTC Datetime string, example: 2021-05-30T12:49:19Z
Body Parameters
Type
Description
event
string
Input one of the Supported Events: 1 - SESSION:SMS_PROCESS
, 2 - SESSION:STAGE_CHANGE
3 - SESSION:STATUS_CHANGE
4 - SESSION:COMPLETE
url
string
Your callback Endpoint URL to receive the events
method
(optional)
string
The method to be used, POST is the default if not provided
headers
(optional)
string
Enter the authentication headers to be included (API key, token)
payload
(optional)
string
Attributes to send along with the default payload for the Supported Events
Sample Response (200:Ok)
Sample Response (400:Bad Request)
Last updated