Sink Test Resource
The Sink Test Resource creates a test event. This test gives you a simple way to publish to yourself and programatically ensure that your Sink is ready to receive events.
To create an active Kinesis Sink, you'll need to complete the following steps. Webhook Sinks are active by default but you can choose to validate them if you would like to. The steps in bold are handled using the Sink Test Resource:
- Create a new Sink Resource. The status of Kinesis Sinks will be
initializedby default. The status of Webhook Sinks will beactiveby default. - Create a Sink Test resource using your new Sink. This will publish a test event to your Sink, confirming that you've set up your Sink properly.
- Check your Sink to see if the Test event was successfully published.
- If the test was successful, retrieve the
test_idand create a Sink Validate Resource. This will let Twilio know that you successfully configured the Sink, and will toggle the Sink state toactive
SinkTest properties
| Resource Properties in REST API format | |
|---|---|
result
|
Feedback indicating whether the test event was generated. |
Create a SinkTest resource
https://events.twilio.com/v1/Sinks/{Sid}/Test
Initiates a test event on a Sink. Once a Test Event has been initiated, the Sink status property will be set to Validating.
If a Test event is initiated twice then the most recent test event will take precedence and the first Test event will no longer be valid.
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
A 34 character string that uniquely identifies the Sink to be Tested. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
