TrueDialog Portal
Administration > Callbacks
This guide will walk you through the process of setting up Callbacks. These Callbacks enable you to integrate your system with TrueDialog’s service. Whenever an event specified by the Callback occurs, TrueDialog sends an HTTP POST request to your selected URL. The Callback feature supports a broad range of events, each sending its unique dataset in JSON format. You can find the variables for each Callback documented in the Payload example section for that specific Callback.
Enable Callbacks
- Click your Account Name in the upper right corner.
- In the dropdown, select Callbacks.
- If Callbacks are disabled:
- Click Enable.
- After enabling Callbacks, a success message will appear in the upper right corner.
- Verify that Callbacks are enabled.
- Click Enable.
Callback Types and Data Formats
| Callback Type | Description |
|---|---|
| Keyword | A callback is sent whenever a text message with a keyword is received. |
| Subscription | A callback is sent whenever an end user opts into a subscription. |
| Survey | A callback is sent whenever an end user responds to a survey. |
| Stop | A callback is sent whenever an end user texts STOP or any other opt-out keywords. |
| New Account | A callback is sent whenever a new child account is created. |
| Incoming Message | A callback is sent whenever an end user sends a text message. |
| Delivery Notice | A callback is sent for each delivery notice receipt. |
| Invalid Targets | A callback is sent if any targets have been filtered out during a push. |
| Clicks | A callback is sent whenever an end user clicks on a link. |
| Long Code Provision | A callback is sent whenever a long code request is completed. |
Look at the {…} Payload example section for an example of the JSON payload that the selected Callback will POST when triggered.
Add a Callback
- Select one of the Callback Types. This guide uses Incoming Message as an example.
- Enter the URL for your Callback in the URL textbox and click Add.
- After adding the Callback, a success message will appear in the upper right corner.
Verify Callback
- Trigger a Callback event and verify that the Callback is working.
- Check the Callback Log for the event you triggered. This guide uses an Incoming Message Callback Type as an example.
- The Callback Log is found below the Callbacks section. Scroll down if necessary.
- Click the button with the Refresh icon.
- Find the logged Callback and verify that the Callback URL is correct.
- Check your server to verify that you received the POST Callback from TrueDialog.
- Verify that the body you received matches the Callback Body sent from TrueDialog.
