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.

Event Properties

(warning)

Warning

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

Property nameTypePIIDescription

account_sidSID<AC>

Not PII

The SID of the Account that created the Event resource.

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

actor_sidSID

Not PII

The SID of the resource that triggered the event.

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

actor_typestring

Not PII

The type of resource that triggered the event.

actor_urlstring<uri>

Not PII

The absolute URL of the resource that triggered the event.

descriptionstring

Not PII

A description of the event.

event_dataobject

Not PII

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

event_datestring<date-time>

Not PII

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

event_date_msinteger<int64>

Not PII

The time the event was sent in milliseconds.

event_typestring

Not PII

The identifier for the event.

resource_sidSID

Not PII

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

resource_typestring

Not PII

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

resource_urlstring<uri>

Not PII

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

sidSID<EV>

Not PII

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

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

sourcestring

Not PII

Where the Event originated.

source_ip_addressstring

Not PII

The IP from which the Event originated.

urlstring<uri>

Not PII

The absolute URL of the Event resource.

workspace_sidSID<WS>

Not PII

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

Not PII

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

Not PII

The SID of the Event resource to fetch.

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

Fetch an Event

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19
_19async function fetchEvent() {
_19  const event = await client.taskrouter.v1
_19    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .events("EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .fetch();
_19
_19  console.log(event.accountSid);
_19}
_19
_19fetchEvent();

Output


_29{
_29  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29  "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29  "actor_type": "workspace",
_29  "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29  "description": "Worker JustinWorker updated to Idle Activity",
_29  "event_data": {
_29    "worker_activity_name": "Offline",
_29    "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29    "worker_attributes": "{}",
_29    "worker_name": "JustinWorker",
_29    "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29    "worker_time_in_previous_activity": "26",
_29    "worker_time_in_previous_activity_ms": "26123",
_29    "workspace_name": "WorkspaceName",
_29    "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_29  },
_29  "event_date": "2015-02-07T00:32:41Z",
_29  "event_date_ms": 987654321111,
_29  "event_type": "worker.activity",
_29  "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29  "resource_type": "worker",
_29  "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29  "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29  "source": "twilio",
_29  "source_ip_address": "1.2.3.4",
_29  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29  "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

Not PII

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

Not PII

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

EventTypestringOptional

Not PII

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

MinutesintegerOptional

Not PII

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

Not PII

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

Not PII

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

Not PII

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

Not PII

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

Not PII

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

Not PII

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

TaskChannelstringOptional

Not PII

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

SidSID<EV>Optional

Not PII

The SID of the Event resource to read.

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

PageSizeintegerOptional

Not PII

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

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

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

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

List all Events from the last 15 minutes

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function listEvent() {
_18  const events = await client.taskrouter.v1
_18    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .events.list({ limit: 20 });
_18
_18  events.forEach((e) => console.log(e.accountSid));
_18}
_18
_18listEvent();

Output


_42{
_42  "events": [
_42    {
_42      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "actor_type": "workspace",
_42      "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "description": "Worker JustinWorker updated to Idle Activity",
_42      "event_data": {
_42        "worker_activity_name": "Offline",
_42        "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42        "worker_attributes": "{}",
_42        "worker_name": "JustinWorker",
_42        "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42        "worker_time_in_previous_activity": "26",
_42        "worker_time_in_previous_activity_ms": "26123",
_42        "workspace_name": "WorkspaceName",
_42        "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_42      },
_42      "event_date": "2015-02-07T00:32:41Z",
_42      "event_date_ms": 987654321111,
_42      "event_type": "worker.activity",
_42      "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "resource_type": "worker",
_42      "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "source": "twilio",
_42      "source_ip_address": "1.2.3.4",
_42      "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_42    }
_42  ],
_42  "meta": {
_42    "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",
_42    "key": "events",
_42    "next_page_url": null,
_42    "page": 0,
_42    "page_size": 50,
_42    "previous_page_url": null,
_42    "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"
_42  }
_42}

List all events from a specified start date

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_21// Download the helper library from https://www.twilio.com/docs/node/install
_21const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_21
_21// Find your Account SID and Auth Token at twilio.com/console
_21// and set the environment variables. See http://twil.io/secure
_21const accountSid = process.env.TWILIO_ACCOUNT_SID;
_21const authToken = process.env.TWILIO_AUTH_TOKEN;
_21const client = twilio(accountSid, authToken);
_21
_21async function listEvent() {
_21  const events = await client.taskrouter.v1
_21    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_21    .events.list({
_21      startDate: new Date("2008-03-18 00:00:00"),
_21      limit: 20,
_21    });
_21
_21  events.forEach((e) => console.log(e.accountSid));
_21}
_21
_21listEvent();

Output


_42{
_42  "events": [
_42    {
_42      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "actor_type": "workspace",
_42      "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "description": "Worker JustinWorker updated to Idle Activity",
_42      "event_data": {
_42        "worker_activity_name": "Offline",
_42        "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42        "worker_attributes": "{}",
_42        "worker_name": "JustinWorker",
_42        "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42        "worker_time_in_previous_activity": "26",
_42        "worker_time_in_previous_activity_ms": "26123",
_42        "workspace_name": "WorkspaceName",
_42        "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_42      },
_42      "event_date": "2015-02-07T00:32:41Z",
_42      "event_date_ms": 987654321111,
_42      "event_type": "worker.activity",
_42      "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "resource_type": "worker",
_42      "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "source": "twilio",
_42      "source_ip_address": "1.2.3.4",
_42      "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_42      "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_42    }
_42  ],
_42  "meta": {
_42    "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",
_42    "key": "events",
_42    "next_page_url": null,
_42    "page": 0,
_42    "page_size": 50,
_42    "previous_page_url": null,
_42    "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"
_42  }
_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.