Query parameters

• ActorSid string

  Only include events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials.

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

• EventType string

  Only include events of this Event Type.

• ResourceSid string

  Only include events that refer to this resource. Useful for discovering the history of a specific resource.

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

• SourceIpAddress string

  Only include events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console.

• StartDate string(date-time)

  Only include events that occurred on or after this date. Specify the date in GMT and ISO 8601 format.

• EndDate string(date-time)

  Only include events that occurred on or before this date. Specify the date in GMT and ISO 8601 format.

• PageSize integer(int64)

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

  Minimum value is 1, maximum value is 1000.

• Page integer

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

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • events array[object]
    Hide events attributes Show events attributes object

    • account_sid string | null

      The SID of the Account that created the Event 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 actor that caused the event, if available. This can be either a User ID (matching the pattern ^US[0-9a-fA-F]{32}$) or an Account SID (matching the pattern ^AC[0-9a-fA-F]{32}$). If the actor's SID isn't available, this field will be null.

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

    • actor_type string | null

      The type of actor that caused the event. Can be: user for a change made by a logged-in user in the Twilio Console, account for an event caused by an API request by an authenticating Account, twilio-admin for an event caused by a Twilio employee, and so on.

    • description string | null

      A description of the event. Can be null.

    • event_data

      An object with additional data about the event. The contents depend on event_type. For example, event-types of the form RESOURCE.updated, this value contains a resource_properties dictionary that describes the previous and updated properties of the resource.

    • event_date string(date-time) | null

      The date and time in GMT when the event was recorded specified in ISO 8601 format.

    • event_type string | null

      The event's type. Event-types are typically in the form: RESOURCE_TYPE.ACTION, where RESOURCE_TYPE is the type of resource that was affected and ACTION is what happened to it. For example, phone-number.created. For a full list of all event-types, see the Monitor Event Types.

    • resource_sid string | null

      The SID of the resource that was affected.

      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 resource that was affected. For a full list of all resource-types, see the Monitor Event Types.

    • sid string | null

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

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

    • source string | null

      The originating system or interface that caused the event. Can be: web for events caused by user action in the Twilio Console, api for events caused by a request to our API, or twilio for events caused by an automated or internal Twilio system.

    • source_ip_address string | null

      The IP address of the source, if the source is outside the Twilio cloud. This value is null for events with source of twilio

    • url string(uri) | null

      The absolute URL of the resource that was affected. Can be null.

    • links object(uri-map) | null

      The absolute URLs of related resources.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)