Get events on a resource

GET

/events

Events

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.

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://app.asana.com/api/1.0/events'

Response Example

200 - Example 1

{
    "data": [
        {
            "action": "changed",
            "change": {
                "action": "changed",
                "added_value": {
                    "gid": "12345",
                    "resource_type": "user"
                },
                "field": "assignee",
                "new_value": {
                    "gid": "12345",
                    "resource_type": "user"
                },
                "removed_value": {
                    "gid": "12345",
                    "resource_type": "user"
                }
            },
            "created_at": "2012-02-22T02:06:58.147Z",
            "parent": {
                "gid": "12345",
                "resource_type": "task",
                "name": "Bug Task"
            },
            "resource": {
                "gid": "12345",
                "resource_type": "task",
                "name": "Bug Task"
            },
            "type": "task",
            "user": {
                "gid": "12345",
                "resource_type": "task",
                "name": "Greg Sanchez"
            }
        }
    ],
    "sync": "de4774f6915eae04714ca93bb2f5ee81"
}

Request

None

Responses

🟢200Successfully retrieved events.

application/json

Body

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

data

array[object (EventResponse) {7}]

optional

action

string

read-onlyoptional

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.

Example:

changed

change

object

read-onlyoptional

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.

created_at

string <date-time>

read-onlyoptional

The timestamp when the event occurred.

Example:

2012-02-22T02:06:58.147Z

parent

object

optional

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

resource

object

optional

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

type

string

read-onlyoptional

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

Example:

task

user

object

optional

The user who triggered the event.

sync

string

optional

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

Example:

de4774f6915eae04714ca93bb2f5ee81

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Modified at 2022-09-13 02:00:31

Get a workspace's custom fields

Get goals