Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Page tools
Useful for sharing or LLM
Accelerate development with AI
On this page
Looking for more inspiration?Visit the

Sink Test resource

The Sink Test Resource creates a test event. This test gives you a way to publish to yourself and programmatically ensure that your Sink is ready to receive events.

Test Properties

test-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
resultstring

Optional

Not PII

Feedback indicating whether the test event was generated.

Create a SinkTest resource

create-a-sinktest-resource page anchor

POST https://events.twilio.com/v1/Sinks/{Sid}/Test

Initiates a test event on a Sink.

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
sidSID<DG>
required
Not PII

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

Pattern: ^DG[0-9a-fA-F]{32}$Min length: 34Max length: 34
Create Sink TestLink to code sample: Create Sink Test
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function createSinkTest() {

14
  const sinkTest = await client.events.v1

15
    .sinks("DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .sinkTest.create();

17


18
  console.log(sinkTest.result);

19
}

20


21
createSinkTest();

Response

Note about this response
1
{

2
  "result": "submitted"

3
}