Custom Events

Make a call to this endpoint for any event-based data representing user actions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The type of event. This name is case sensitive. "Order shipped" and "Order Shipped" would be considered different event types.

The Custom Event type cannot any of the following special characters:

  • double quote "
  • single quote '
  • parentheses ( )
  • curly braces { }
  • square brackets [ ]
  • backslash \
  • vertical bar |
  • commas ,
properties
object

Any metadata associated with the event.

Object keys are expected to be strings, and cannot contain any of the following special characters:

  • double quote "
  • curly braces { }
  • square brackets [ ]
  • backslash \
  • vertical bar |

Object values can be any type. Note that both object keys and object values are case sensitive. For example, "deliverydate" and "DeliveryDate" would be considered different event properties.

Notes:

  • When you’re creating journeys that use custom events data, you can only use lists and nested objects can only be used with email messages. Lists and nested objects are not currently supported for SMS.
  • For URLs that are provided as a value, Attentive will automatically shorten the link with your brand's link shortener. For example, https://mysite.com/. Note that Attentive can only shorten URLs that are 1,024 characters or fewer.
  • Custom events must be triggered using the same custom app that originally created them.
  • There is a maximum of 200 object keys per custom event type. While payloads larger than this will be saved, not all keys will be available for use in Journeys and macros.
string

A unique identifier representing this specific event. A UUID is recommended.

date-time

Timestamp of when the action occurred in RFC 3339 format with required UTC offset. If the timestamp is older than 12 hours, it will not trigger any relevant Journeys. If no timestamp is provided, it is assumed the event occurred when the endpoint is called.

user
object
required

User associated with the action. Note that this is a visitor to the site and does not need to be actively subscribed to Attentive. Phone, email, or an external identifier (clientUserId or another custom identifier) are required

Responses
200

Ok

400

Invalid parameter in request query or body

401

Unauthorized

403

Access Denied

404

The specified resource was not found

429

The user has sent too many requests in a given amount of time

500

Internal Server Error

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…