Create a new Sink Test Event for the given Sink.

POST /v1/Sinks/{Sid}/Test

Test sink

Create a new Sink Test Event for the given Sink.

Path parameters

  • Sid string Required

    A 34 character string that uniquely identifies the Sink to be Tested.

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

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 attribute Show response attribute object
    • result string | null

      Feedback indicating whether the test event was generated.

  • 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 attribute Show response attribute object
    • result string | null

      Feedback indicating whether the test event was generated.

POST /v1/Sinks/{Sid}/Test
curl \
 --request POST 'https://events.twilio.com/v1/Sinks/{Sid}/Test' \
 --user "username:password"
Response examples (200)
{
  "result": "submitted"
}
Response examples (201)
{
  "result": "submitted"
}