Smartsheet logo

Objects

Event Object

eventId
string

Unique event identifier.

objectType
string

The Smartsheet resource impacted by the event, such as, SHEET or WORKSPACE.

Enum: "SHEET" "WORKSPACE"
action
string

The action applied to the specified object, such as CREATE or DELETE.

objectId
string

The identifier of the object impacted by the event.

eventTimeStamp
string <date-time>

Date and time of the event. Defaults to ISO-8601 format. See dates and times for more information.

userId
number

User assumed as the one who initiated the event. Usually the userId property and the requestUserId property (below) have the same value. However, if the request is an API call with Assume-User header then the userId property identifies the user whose email matches the value in the Assume-User header.

requestUserId
number

User whose authentication credential is embedded in the request that initiated the event. For example, if the request is an API call with an access token then requestUserId identifies the user whose data can be accessed via the access token (i.e., the user who authorized the creation of the access token). On the other hand, if the request comes from a UI session, then requestUserId identifies the user logged-in to the UI.

accessTokenName
string

Name of the access token embedded in the request. This property is omitted if there's no access token in the request (i.e., it isn't an API call) or if the access token wasn't given a name when created (only access tokens generated via the Smartsheet desktop UI can be given a name at creation time).

source
string

Identifies the type of action that triggered the event.

object

Container object for additional event-specific properties. Properties depend upon the event type. See Event Reporting reference documentation for details on each event type.

{
  • "eventId": "4b12345abc444def333g149he2b15b3j",
  • "objectType": "sheet",
  • "action": "CREATE",
  • "objectId": 345678901234,
  • "eventTimeStamp": "2019-08-24T14:15:22Z",
  • "userId": 123457654321,
  • "requestUserId": 133445566778,
  • "accessTokenName": "string",
  • "source": "WEB_APP",
  • "additionalDetails": { }
}

StreamResult Object

nextStreamPosition
string

This string should be passed back to the next GET events call to obtain subsequent events.

moreAvailable
boolean

True if more results are available. This is typically due to event counts exceeding the maxCount parameter passed in.

{
  • "nextStreamPosition": "XyzAb1234cdefghijklmnofpq",
  • "moreAvailable": true
}
➔ Next to Methods