Fetch event

GET /v1/Workspaces/{WorkspaceSid}/Events/{Sid}

TODO: Resource-level docs

Path parameters

  • WorkspaceSid string Required

    The SID of the Workspace with the Event to fetch.

  • Sid string Required

    The SID of the Event resource to fetch.

Responses

  • OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • actor_sid string | null

      The SID of the resource that triggered the event

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$.

    • actor_type string | null

      The type of resource that triggered the event

    • actor_url string(uri) | null

      The absolute URL of the resource that triggered the event

    • description string | null

      A description of the event

    • Data about the event

    • event_date string(date-time) | null

      The time the event was sent

    • event_date_ms integer | null

      The time the event was sent in milliseconds

    • event_type string | null

      The identifier for the event

    • resource_sid string | null

      The SID of the object the event is most relevant to

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$.

    • resource_type string | null

      The type of object the event is most relevant to

    • resource_url string(uri) | null

      The URL of the resource the event is most relevant to

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^EV[0-9a-fA-F]{32}$.

    • source string | null

      Where the Event originated

    • source_ip_address string | null

      The IP from which the Event originated

    • url string(uri) | null

      The absolute URL of the Event resource

    • workspace_sid string | null

      The SID of the Workspace that contains the Event

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

GET /v1/Workspaces/{WorkspaceSid}/Events/{Sid}
curl \
 -X GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Events/{Sid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "actor_sid": "string",
  "actor_type": "string",
  "actor_url": "https://example.com",
  "description": "string",
  "event_date": "2023-05-04T09:42:00+00:00",
  "event_date_ms": 42,
  "event_type": "string",
  "resource_sid": "string",
  "resource_type": "string",
  "resource_url": "https://example.com",
  "sid": "string",
  "source": "string",
  "source_ip_address": "string",
  "url": "https://example.com",
  "workspace_sid": "string"
}
Response examples (200)
{
  "account_sid": "string",
  "actor_sid": "string",
  "actor_type": "string",
  "actor_url": "https://example.com",
  "description": "string",
  "event_date": "2024-05-04T09:42:00+00:00",
  "event_date_ms": 42,
  "event_type": "string",
  "resource_sid": "string",
  "resource_type": "string",
  "resource_url": "https://example.com",
  "sid": "string",
  "source": "string",
  "source_ip_address": "string",
  "url": "https://example.com",
  "workspace_sid": "string"
}