On this page

Sink Validate Resource

There is no longer a need for validating a Sink. The status of Sinks is active by default.

Validate Properties

Property nameTypeRequiredDescriptionChild properties

resultstring

Optional

Not PII

Feedback indicating whether the given Sink was validated.

Create a SinkValidate resource

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

A request to create a new Sink Validation Resource always returns a result property with a value of valid (to avoid disrupting existing customer workflows).

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<DG>required

Not PII

A 34 character string that uniquely identifies the Sink being validated.

Pattern: ^DG[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

TestIdstringrequired

Not PII

A 34 character string that uniquely identifies the test event for a Sink being validated.

Post Sink Validate

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createSinkValidate() {
11  const sinkValidate = await client.events.v1
12    .sinks("DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .sinkValidate.create({ testId: "95001c1e-5b8e-45f5-830d-f9cbf1d16420" });
14
15  console.log(sinkValidate.result);
16}
17
18createSinkValidate();

Output

1{
2  "result": "valid"
3}