Menu

Expand
Rate 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.

Event properties

Resource Properties in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the Event resource.

actor_sid
sid Not PII

The SID of the resource that triggered the event.

actor_type
string Not PII

The type of resource that triggered the event.

actor_url
url Not PII

The absolute URL of the resource that triggered the event.

description
string Not PII

A description of the event.

event_data
object Not PII

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

event_date
date_time<iso8601> Not PII

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

event_date_ms
long Not PII

The time the event was sent in milliseconds.

event_type
string Not PII

The identifier for the event.

resource_sid
sid Not PII

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

resource_type
string Not PII

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

resource_url
url Not PII

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

sid
sid<EV> Not PII

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

source
string Not PII

Where the Event originated.

source_ip_address
string Not PII

The IP from which the Event originated.

url
url Not PII

The absolute URL of the Event resource.

workspace_sid
sid<WS> Not PII

The SID of the Workspace that contains the Event.

Fetch an Event resource

get
https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Events/{Sid}
Parameters
Parameters in REST API format
workspace_sid
Path
get sid<WS> Not PII

The SID of the Workspace with the Event to fetch.

sid
Path
get sid<EV> Not PII

The SID of the Event resource to fetch.

Example 1
        
        
        

        List all Events

        get
        https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Events
        Parameters
        Parameters in REST API format
        workspace_sid
        Path
        get sid<WS> Not PII

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

        end_date
        Optional
        get date_time<iso8601> Not PII

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

        event_type
        Optional
        get string Not PII

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

        minutes
        Optional
        get integer 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.

        reservation_sid
        Optional
        get sid<WR> Not PII

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

        start_date
        Optional
        get date_time<iso8601> 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.

        task_queue_sid
        Optional
        get sid<WQ> Not PII

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

        task_sid
        Optional
        get sid<WT> Not PII

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

        worker_sid
        Optional
        get sid<WK> Not PII

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

        workflow_sid
        Optional
        get sid<WW> Not PII

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

        task_channel
        Optional
        get string Not PII

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

        sid
        Optional
        get sid<EV> Not PII

        The SID of the Event resource to read.

        Example 1
              
              
              
              Example 2
                    
                    
                    

                    For Accounts created before September 2, 2021, if the StartDate of the Events request is greater than 30 days in the past, then the events returned will not contain fields that may contain Personally Identifiable Information. The fields labeled as PII in the tables below will be redacted.

                    Beginning September 2, 2021 for new accounts, and November 30, 2021 for existing accounts, if the StartDate of the Events request is greater than 30 days in the past, those queries are no longer serviced and instead a 400-error response is returned.

                    Rate this page:

                    Need some help?

                    We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Community Forums or browsing the Twilio tag on Stack Overflow.

                          
                          
                          

                          Thank you for your feedback!

                          We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                          Sending your feedback...
                          🎉 Thank you for your feedback!
                          Something went wrong. Please try again.

                          Thanks for your feedback!

                          Refer us and get $10 in 3 simple steps!

                          Step 1

                          Get link

                          Get a free personal referral link here

                          Step 2

                          Give $10

                          Your user signs up and upgrade using link

                          Step 3

                          Get $10

                          1,250 free SMSes
                          OR 1,000 free voice mins
                          OR 12,000 chats
                          OR more