TWtwilio
EventsV1Sink

Create a new Sink

Changed on

Create a new Sink

post/v1/Sinks

Request

  • Base URL
    https://events.twilio.com
  • URL
    https://events.twilio.com/v1/Sinks
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

Descriptionstring required

A human readable description for the Sink This value should not contain PII.

SinkConfigurationunknown required
SinkType'kinesis' | 'webhook' | 'segment' | 'email' required

The Sink type. Can only be "kinesis" or "webhook" currently.

Response

Created

date_createdstring date-time nullable

The date that this Sink was created, given in ISO 8601 format.

date_updatedstring date-time nullable

The date that this Sink was updated, given in ISO 8601 format.

descriptionstring nullable

A human readable description for the Sink

sidstring nullable

A 34 character string that uniquely identifies this Sink.

sink_configurationunknown
sink_type'kinesis' | 'webhook' | 'segment' | 'email'

The Sink type. Can only be "kinesis" or "webhook" currently.

status'initialized' | 'validating' | 'active' | 'failed'

The Status of this Sink. One of initialized, validating, active or failed.

urlstring uri nullable

The URL of this resource.

linksobject nullable

Contains a dictionary of URL links to nested resources of this Sink.

Changes

  • v12bc57338abc5Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • info

      the request property type was generalized from object to no type

  • v12ad3c7d7e22bRevision changes
    • breaking

      the request property type changed from no type to object

    • breaking

      the response's property type changed from no type to object for status

    • warning

      added the new email enum value to the response property for the response status

    • info

      added the new email enum value to the request property