Create a new Sink

POST /v1/Sinks
Account sid auth token

Sink destination to send events to

Create a new Sink

application/x-www-form-urlencoded

Body

  • Description string Required

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

  • SinkConfiguration Required

    The information required for Twilio to connect to the provided Sink encoded as JSON.

  • SinkType string Required

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

    Values are kinesis, webhook, segment, or email.

Responses

  • 201 application/json

    Created

    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
    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • description string | null

      A human readable description for the Sink

    • sid string | null

      A 34 character string that uniquely identifies this Sink.

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

    • sink_configuration

      The information required for Twilio to connect to the provided Sink encoded as JSON.

    • sink_type string

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

      Values are kinesis, webhook, segment, or email.

    • status string

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

      Values are initialized, validating, active, or failed.

    • url string(uri) | null

      The URL of this resource.

    • links object(uri-map) | null

      Contains a dictionary of URL links to nested resources of this Sink.
POST /v1/Sinks 
curl \
 --request POST 'https://events.twilio.com/v1/Sinks' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'SinkType=kinesis&Description=My+Kinesis+Sink&SinkConfiguration=%7B%22arn%22%3A+%22arn%3Aaws%3Akinesis%3Aus-east-1%3A111111111%3Astream%2Ftest%22%2C%22role_arn%22%3A+%22arn%3Aaws%3Aiam%3A%3A111111111%3Arole%2FRole%22%2C%22external_id%22%3A+%221234567890%22%7D'
Request examples 
{"SinkType"=>"kinesis", "Description"=>"My Kinesis Sink", "SinkConfiguration"=>"{\"arn\": \"arn:aws:kinesis:us-east-1:111111111:stream/test\",\"role_arn\": \"arn:aws:iam::111111111:role/Role\",\"external_id\": \"1234567890\"}"}
{"SinkType"=>"segment", "Description"=>"My segment Sink", "SinkConfiguration"=>"{\"write_key\": \"MY_WRITEKEY\"}"}
Response examples (201) 
{
  "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test",
    "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate"
  },
  "status": "initialized",
  "sink_type": "kinesis",
  "description": "My Kinesis Sink",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "sink_configuration": {
    "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test",
    "role_arn": "arn:aws:iam::111111111:role/Role",
    "external_id": "1234567890"
  }
}
{
  "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test",
    "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate"
  },
  "status": "initialized",
  "sink_type": "segment",
  "description": "My segment Sink",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "sink_configuration": {
    "write_key": "MY_WRITEKEY"
  }
}