Skip to content Skip to navigation Skip to topbar

On this page

Event Resource

TaskRouter logs Events for each state change in the Workspace for the purpose of historical reporting and auditing; it keeps that data for 30 days. To learn more about what events to expect and how they work, please visit the Event Reference page.

Validate only against the attributes listed on this page. Do not validate against other attributes that you may see, which are for features that aren't publicly available yet. Any attributes that aren't publicly documented may change or be removed without notice, and you may experience unexpected behavior.

Event Properties

(warning)

Warning

Pagination is not supported under this resource. Please avoid usage of the page query parameter.

Property nameTypeRequiredDescriptionChild properties

accountSidSID<AC>

Optional

The SID of the Account that created the Event resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

actorSidSID

Optional

The SID of the resource that triggered the event.

Pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$Min length: 34Max length: 34

actorTypestring

Optional

The type of resource that triggered the event.

actorUrlstring<uri>

Optional

The absolute URL of the resource that triggered the event.

descriptionstring

Optional

A description of the event.

eventDataobject

Optional

Data about the event. For more information, see Event types.

eventDatestring<date-time>

Optional

The time the event was sent, specified in ISO 8601 format.

eventDateMsinteger<int64>

Optional

The time the event was sent in milliseconds.

eventTypestring

Optional

The identifier for the event.

resourceSidSID

Optional

The SID of the object the event is most relevant to, such as a TaskSid, ReservationSid, or a WorkerSid.

Pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$Min length: 34Max length: 34

resourceTypestring

Optional

The type of object the event is most relevant to, such as a Task, Reservation, or a Worker).

resourceUrlstring<uri>

Optional

The URL of the resource the event is most relevant to.

sidSID<EV>

Optional

The unique string that we created to identify the Event resource.

Pattern: ^EV[0-9a-fA-F]{32}$Min length: 34Max length: 34

sourcestring

Optional

Where the Event originated.

sourceIpAddressstring

Optional

The IP from which the Event originated.

urlstring<uri>

Optional

The absolute URL of the Event resource.

workspaceSidSID<WS>

Optional

The SID of the Workspace that contains the Event.

Pattern: ^WS[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch an Event resource

GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Events/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

The SID of the Workspace with the Event to fetch.

Pattern: ^WS[0-9a-fA-F]{32}$Min length: 34Max length: 34

sidSID<EV>

required

The SID of the Event resource to fetch.

Pattern: ^EV[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch an Event

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchEvent() {
11  const event = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .events("EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .fetch();
15
16  console.log(event.accountSid);
17}
18
19fetchEvent();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "actor_type": "workspace",
5  "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "description": "Worker JustinWorker updated to Idle Activity",
7  "event_data": {
8    "worker_activity_name": "Offline",
9    "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10    "worker_attributes": "{}",
11    "worker_name": "JustinWorker",
12    "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13    "worker_time_in_previous_activity": "26",
14    "worker_time_in_previous_activity_ms": "26123",
15    "workspace_name": "WorkspaceName",
16    "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
17  },
18  "event_date": "2015-02-07T00:32:41Z",
19  "event_date_ms": 987654321111,
20  "event_type": "worker.activity",
21  "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
22  "resource_type": "worker",
23  "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
24  "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
25  "source": "twilio",
26  "source_ip_address": "1.2.3.4",
27  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
28  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
29}

List all Events

GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Events

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

The SID of the Workspace with the Events to read. Returns only the Events that pertain to the specified Workspace.

Pattern: ^WS[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

endDatestring<date-time>

Optional

Only include Events that occurred on or before this date, specified in GMT as an ISO 8601 date-time.

eventTypestring

Optional

The type of Events to read. Returns only Events of the type specified.

minutesinteger

Optional

The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is 15 minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted.

reservationSidSID<WR>

Optional

The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation.

Pattern: ^WR[0-9a-fA-F]{32}$Min length: 34Max length: 34

startDatestring<date-time>

Optional

Only include Events from on or after this date and time, specified in ISO 8601 format. Task Attributes for Events older than 30 days will be redacted.

taskQueueSidSID<WQ>

Optional

The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue.

Pattern: ^WQ[0-9a-fA-F]{32}$Min length: 34Max length: 34

taskSidSID<WT>

Optional

The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task.

Pattern: ^WT[0-9a-fA-F]{32}$Min length: 34Max length: 34

workerSidSID<WK>

Optional

The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker.

Pattern: ^WK[0-9a-fA-F]{32}$Min length: 34Max length: 34

workflowSidSID<WW>

Optional

The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow.

Pattern: ^WW[0-9a-fA-F]{32}$Min length: 34Max length: 34

taskChannelstring

Optional

The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel.

sidSID<EV>

Optional

The SID of the Event resource to read.

Pattern: ^EV[0-9a-fA-F]{32}$Min length: 34Max length: 34

pageSizeinteger<int64>

Optional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

pageinteger

Optional

The page index. This value is simply for client state.

Minimum: 0

pageTokenstring

Optional

The page token. This is provided by the API.

List all Events from the last 15 minutes

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listEvent() {
11  const events = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .events.list({ limit: 20 });
14
15  events.forEach((e) => console.log(e.accountSid));
16}
17
18listEvent();

Response

1{
2  "events": [
3    {
4      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "actor_type": "workspace",
7      "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8      "description": "Worker JustinWorker updated to Idle Activity",
9      "event_data": {
10        "worker_activity_name": "Offline",
11        "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12        "worker_attributes": "{}",
13        "worker_name": "JustinWorker",
14        "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15        "worker_time_in_previous_activity": "26",
16        "worker_time_in_previous_activity_ms": "26123",
17        "workspace_name": "WorkspaceName",
18        "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
19      },
20      "event_date": "2015-02-07T00:32:41Z",
21      "event_date_ms": 987654321111,
22      "event_type": "worker.activity",
23      "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
24      "resource_type": "worker",
25      "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
26      "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
27      "source": "twilio",
28      "source_ip_address": "1.2.3.4",
29      "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
30      "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
31    }
32  ],
33  "meta": {
34    "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
35    "key": "events",
36    "next_page_url": null,
37    "page": 0,
38    "page_size": 50,
39    "previous_page_url": null,
40    "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0"
41  }
42}

List all events from a specified start date

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listEvent() {
11  const events = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .events.list({
14      startDate: new Date("2008-03-18 00:00:00"),
15      limit: 20,
16    });
17
18  events.forEach((e) => console.log(e.accountSid));
19}
20
21listEvent();

Response

1{
2  "events": [
3    {
4      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "actor_type": "workspace",
7      "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8      "description": "Worker JustinWorker updated to Idle Activity",
9      "event_data": {
10        "worker_activity_name": "Offline",
11        "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12        "worker_attributes": "{}",
13        "worker_name": "JustinWorker",
14        "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15        "worker_time_in_previous_activity": "26",
16        "worker_time_in_previous_activity_ms": "26123",
17        "workspace_name": "WorkspaceName",
18        "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
19      },
20      "event_date": "2015-02-07T00:32:41Z",
21      "event_date_ms": 987654321111,
22      "event_type": "worker.activity",
23      "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
24      "resource_type": "worker",
25      "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
26      "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
27      "source": "twilio",
28      "source_ip_address": "1.2.3.4",
29      "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
30      "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
31    }
32  ],
33  "meta": {
34    "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
35    "key": "events",
36    "next_page_url": null,
37    "page": 0,
38    "page_size": 50,
39    "previous_page_url": null,
40    "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0"
41  }
42}

(warning)

Warning

If the StartDate of the Events request is greater than 30 days in the past then the query will be serviced a 400-error response.