POST
Add an event

Authorizations

Authorization
string
header
required

A key from Settings → API keys. It starts with gd_key_.

Body

application/json
partyId
string<uuid>
required

The CRM's id for the contact, from upsert, get or resolve.

Example:

"01a1f7c6-3a71-74f2-8a38-22909d8dc050"

name
string
required
Required string length: 1 - 120
Example:

"project.created"

properties
object
Example:
occurredAt
string<date-time>

ISO 8601. Now when omitted.

idempotencyKey
string
Required string length: 1 - 200

Response

The event

message
string
required
Example:

"Event added"

metaData
object
required
data
object
required