Get events on a resource

Returns the full record for all events that have occurred since the sync
token was created.

A GET request to the endpoint /[path_to_resource]/events can be made in
lieu of including the resource ID in the data for the request.

Asana limits a single sync token to 100 events. If more than 100 events exist
for a given resource, has_more: true will be returned in the response, indicating
that there are more events to pull.

Note: The resource returned will be the resource that triggered the
event. This may be different from the one that the events were requested
for. For example, a subscription to a project will contain events for
tasks contained within the project.

Query Params
array of strings

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

opt_fields
string
required

A resource ID to subscribe to. The resource can be a task, project, or goal.

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.

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.

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
Request
Asana Home
Asana helps you manage projects, focus on what's important, and organize work in one place for seamless collaboration.
© 2023 Asana, Inc.