Get workspace events

Returns the full record for all events that have occurred since the sync token was created.
The response is a list of events and the schema of each event is as described here.
Asana limits a single sync token to 1000 events. If more than 1000 events exist for a given domain, has_more: true will be returned in the response, indicating that there are more events to pull.

📘

Access requirements

Currently, access to this API is exclusively available through a service account in an Enterprise+ domain. To get started, see the workspace events guide.

Path Params
string
required

Globally unique identifier for the workspace or organization.

Query Params
boolean

Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

string

A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated.
Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token. If the sync token is too old (which may happen from time to time) the API will return a 412 Precondition Failed error, and include a fresh sync token in the response.

Responses

Response body
object
array of objects
data
object
object

The user who triggered the event.

object

The resource which has triggered the event by being modified in some way.

string

Deprecated: Refer to the resource_type of the resource. The type of the resource that generated the event.

string

The type of action taken on the resource that triggered the event. This can be one of changed, added, removed, deleted, or undeleted depending on the nature of the event.

object

For added/removed events, the parent object that resource was added to or removed from. The parent will be null for other event types.

date-time

The timestamp when the event occurred.

object

Information about the type of change that has occurred. This field is only present when the value of the property action, describing the action taken on the resource, is changed.

string

A sync token to be used with the next call to the /events endpoint.

boolean

Indicates whether there are more events to pull.

Language
Credentials
Asana Home
Asana helps you manage projects, focus on what's important, and organize work in one place for seamless collaboration.
© 2023 Asana, Inc.