Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-144317.9 KB

get/v1/Events/{Sid}

Path parameters

Sidstring required

The SID of the Event resource to fetch.

Response

OK

account_sidstring nullable

The SID of the Account that created the Event resource.

actor_sidstring nullable

The SID of the actor that caused the event, if available. Can be null.

actor_typestring nullable

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.

descriptionstring nullable

A description of the event. Can be null.

{"stackTrail":"components:schemas:monitor.v1.event:properties:event_data","oasType":"schema","type":"unknown","description":"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.","nullable":true}
event_datestring date-time nullable

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

event_typestring nullable

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.

linksobject nullable

The absolute URLs of related resources.

resource_sidstring nullable

The SID of the resource that was affected.

resource_typestring nullable

The type of resource that was affected. For a full list of all resource-types, see the Monitor Event Types.

sidstring nullable

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

sourcestring nullable

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_addressstring nullable

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

urlstring uri nullable

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