Callbacks are Vibes-initiated requests to the endpoint of your choice. Our Callback API allows you to register to receive callbacks, retrieve previously sent callbacks, and more.
Available API methods
- Register for a new callback type
- List registered callbacks
- Get a callback
- Cancel a callback
- Create a test callback event
Elements & Attributes
Data Element | Type | Description | Required? | Default |
---|---|---|---|---|
| String | Vibes unique identifier for each callback record. | N/A | |
| String | Callback type to trigger this callback. Replacement for parameter event_type, which has multiple meaning throughout the platform. |
| |
| String | DEPRECIATED: This field is being depreciated and may be removed in the future. We recommend using Callback/event type to trigger this callback. |
| |
| String | External URL to submit the callback data. You may register multiple unique callback entities to send to different url endpoints (Limit 50). Length is limited to 1024 characters. | Required | |
| String | Method to submit the data to the destination URL. | Optional | POST |
| String | Content type to set when submitting the data to the destination URL. Valid content types:
| Optional | application/json |
| Timestamp | Date you’d like to start receiving this callback. It should be in the ISO 8601 format - for example: 2017-04-05T14:30Z. | Optional | Now |
| Timestamp | Date you’d like to stop receiving this callback. It should be in the ISO 8601 format - for example: 2017-04-05T14:30Z. | Optional | No end date |
| String | Unique resource URL for the callback. | N/A | |
| Timestamp | Date this callback was created. This is a system-generated field and will appear in ISO 8601 format - for example: 2017-04-05T14:30Z. | N/A | |
| Timestamp | Date this callback was last updated. This is a system-generated field and will appear in ISO 8601 format - for example: 2017-04-05T14:30Z. | N/A | |
| String | Vibes unique identifier for a subscription list. | Required for Subscription Callback Types | |
| String | Vibes unique identifier for an acquisition campaign. | Required for Acquisition Callback Types | |
| String | The short code, long code, or alpha code associated with the callback. | Required for Unmatched Message Callback Types | |
| String | The country code for the source code associated with this callback. | Required for Unmatched Message Callback Types | |
| String | The campaign token for the wallet campaign. | Required for Wallet Item Callback Types |