Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
Custom Events

Send an event

Sends an event.

post/event/events

Request body

eventNamestring required

Name of the event. One of the custom event names you previously defined.

occurTimestring date-time

The time at which the event occurred, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z, if not provided, the current time will be used.

objectIdstring

ID of the object that the event is associated with. For events defined with objectType as CONTACT, the objectId should be a contact ID. Alternatively, you can use the contactPhoneNumber field to specify the contact.

contactPhoneNumberstring

The phone number of the contact for events defined with objectType as CONTACT.

propertiesobject

The properties of the custom event.

Example request

{
  "eventName": "unique_event_name",
  "occurTime": "2022-06-01T12:00:00.000Z",
  "properties": {
    "property1": "value1",
    "property2": "value2"
  }
}

Response

Successfully sent the event.