Event

Application events, capturing details around the initiator, recipient, etc.

body
string or null

The event body (for external events only)

createdAt
string or null <date-time>

The date and time the event was created.

eventAt
string or null <date-time>

The date and time the event occurred.

externalUrl
string or null

The external URL associated with this event (for external events only)

name
string or null <= 255 characters

The name of the event that took place (e.g. "mailbox_created").

payload
object or null

The transmitted data for the event (cannot be updated once an event has been created)

requestCity
string or null <= 255 characters

The city where the request that created the event was made.

requestDevice
string or null <= 255 characters

The type of device on which the request that created the event was made.

requestHost
string or null <= 255 characters

Name of the host from which the request was made.

requestProxied
boolean or null

A boolean value whether the request was proxied. For example, when true the request city refers to the location of the email server and not the prospect.

requestRegion
string or null <= 255 characters

Name of the region from which the request was made.

{
  • "body": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "eventAt": "2019-08-24T14:15:22Z",
  • "externalUrl": "string",
  • "name": "string",
  • "payload": { },
  • "requestCity": "string",
  • "requestDevice": "string",
  • "requestHost": "string",
  • "requestProxied": true,
  • "requestRegion": "string"
}

Event Relationships

object

The account associated with this event. You can use only the attribute id to filter events by account (e.g. filter[account][id]=X).

object

The call associated with this event. You can use only the attribute id to filter events by call (e.g. filter[call][id]=X).

object

The mailing associated with this event. You can use only the attribute id to filter events by mailing (e.g. filter[mailing][id]=X).

object

The note associated with this event.

object

The opportunity associated with this event. You can use only the attribute id to filter events by opportunity (e.g. filter[opportunity][id]=X).

object

The plugin associated with this event.

object

The prospect associated with this event. You can use only the attribute id to filter events by prospect (e.g. filter[prospect][id]=X).

object

The sequence associated with this event.

object

The sequence step associated with this event.

object

The task associated with this event. You can use only the attribute id to filter events by task (e.g. filter[task][id]=X).

object

The user associated with this event. You can use only the attribute id to filter events by user (e.g. filter[user][id]=X).

{
  • "account": {},
  • "call": {},
  • "mailing": {},
  • "note": {},
  • "opportunity": {},
  • "plugin": {},
  • "prospect": {},
  • "sequence": {},
  • "sequenceStep": {},
  • "task": {},
  • "user": {}
}

Event Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
dataConnections The set of connections a given Event has to external sources. provideDataConnections

⌵ Event Actions

Get a Collection of Events

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/events
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Get an Event by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/events/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}