Custom Events

Push custom events to trigger Emotive Flows

Requirements

To use the custom_event endpoint, requests must be made against a base URL of https://www.emotiveapp.co/ Requests are authenticated using an Authorization header with value: Token <YOUR_API_KEY> .

Push a Custom Event

You must send at least a phone_number oremail to identify the subscriber for which the event belongs

POST https://emotiveapp.co/campaign_engine/api/v1/custom_events/

Headers

Name	Value
Content-Type	application/json
Authorization	Token <YOUR_API_KEY>

Body

Name	Type	Description
phone_number	string	E164 Formatted Subscriber Phone Number
email	string
event_name	string	Descriptive name for the custom event, eg: user-clicked
event_datetime	string	ISO-8601 formatted timestamp
properties	object	key/value pairs of event properties

Response

200

{
    "message": "success"
}

401

Using Custom Events

To make use of custom events within Emotive, you must create a new Flow (Experience) with a "Custom Event" trigger that is filtered to the appropriate event_name: