On occasion, you may want to send messages—SMS, MMS, or push—to your customers that correspond to key events in their customer journey.
For example, say you’d like to send your customer a text message when their item is shipped. The first step in this process is to create a defined event that informs the Vibes system that the item has been shipped.
The easiest way to define an event_type
is in the platform (see step one of this guide for more info).
Use unique
event_id
sThe
event_id
should be unique for association and debugging purposes. If you plan on registering for event-triggered callbacks, we recommend providing anevent_id
, as this can make identifying the originated event easier in the future. If theevent_id
is be omitted, the platform will generate a unique ID. Re-using anevent_id
may result in successive events failing.
Available API Methods
Elements & Attributes
Field Name | Type | Description | Required? |
---|---|---|---|
| String | Used to identify a linked API-triggered event in the Platform. Valid characters in the
| Yes |
| Object | A placeholder object that can contain any useful data relevant to the event. Any valid JSON can be provided within the object for later reference within the API-triggered event in the Platform. These fields are carried through on the event and can be referenced by any of the actions to filter or personalize the action to the individual event. | Yes |
| String | Identifies the intended recipient of the triggered event message. See Person APIs for more information on this field.
| Yes* |
| String | Identifies the intended recipient of the triggered event message. See Person APIs for more information on this field.
| Yes* |
| String | Identifies the intended device of the triggered event message for push messages.
| Yes* |
| String | The The | No |
| Object | Similar to the | No |
Entity Example
{
"event_id": "2d4a2",
"event_type": "day_of_delivery",
"event_data": {
"first_name": "Bob",
"external_person_id": "abcd12345",
"delivery_time": "5:00 PM",
"order_url": "https://example.com/orders/12345"
},
"debug_data": {
"field": "CUST_SYSTEM"
}
}