Event

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

body
string

The event body (for external events only)

createdAt
string <date-time>

The date and time the event was created.

eventAt
string <date-time>

The date and time the event occurred.

externalUrl
string

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

name
string <= 255 characters

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

payload
object

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

requestCity
string <= 255 characters

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

requestDevice
string <= 255 characters

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

requestHost
string <= 255 characters

Name of the host from which the request was made.

requestProxied
boolean

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 <= 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

data (object) or links (object) (account)

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

data (object) or links (object) (call)

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

data (object) or links (object) (mailing)

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

data (object) or links (object) (opportunity)

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

data (object) or links (object) (prospect)

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

data (object) or links (object) (task)

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

data (object) or links (object) (user)

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": {
    },
  • "opportunity": {
    },
  • "prospect": {
    },
  • "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": {
    }
}