HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

Create Event

Create an event. Events are created asynchronously.
Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.

Rate limits:
Burst: 350/s
Steady: 3500/m

Scopes:
Events Write

Body Params

Event to create.

object
required
string
required
object
required
object
required

Properties of the profile that triggered this event. The profile must contain an
identifier. The $email and/or $phone_number can be used as the identify the profile.
Other key value pairs can be used to create segments. For example, to create a list of
people on trial plans, include a profile's plan type in the profile. The profile
supports special fields. The fields include: $email (string), $first_name (string),
$last_name (string), $phone_number (string), $city (string), $region (string; state or
other region), $country (string), $zip (string), $image (string; url to a photo of a
person), and $consent (list of strings; eg: ['sms', 'email', 'web', 'directmail',
'mobile']).

string
object
required

The associated metric for the event. An account can have up to 200 unique metrics.

string
required
Defaults to Viewed Product

Name of the event. Must be less than 128 characters.

string

This is for advanced usage. For api requests, this should use the default, which is set to api.

object
required

Properties of this event. Any top level property (that are not objects) can be
used to create segments. The $extra property is a special property. This records any
non-segmentable values that can be references later. For example, HTML templates are
useful on a segment, but itself is not used in creating a segment. There are limits
placed onto the size of the data present. This must not exceed 5 MB. This must not
exceed 300 event properties. A single string cannot be larger than 100 KB. Each array
must not exceed 4000 elements. The properties cannot contain more than 10 nested levels.

string
date-time
Defaults to 2022-11-08T00:00:00

When this event occurred. By default, the time the request was received will be used.
The time is truncated to the second. The time must be after the year 2000 and can only
be up to 1 year in the future.

number
Defaults to 9.99

A numeric value to associate with this event. For example, the dollar amount of a purchase.

string

A unique identifier for an event. If the unique_id is repeated for the same
profile and metric, only the first processed event will be recorded. If this is not
present, this will use the time to the second. Using the default, this limits only one
event per profile per second.

Headers
string
required
Defaults to 2023-01-24

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses
202

Language
Credentials