Twilio/events

@keeb/twilio/eventsv2026.08.25.2· 16d agoMODELS

01README

Twilio events API models

02Release Notes

Updated: event_type, schema_version, sink, subscribed_event, subscription

03Models8

@keeb/twilio/events/event-typev2026.08.25.2event_type.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a event type

Argument	Type	Required	Description
id	string	yes	The type of the event type

fn lookup(schema_id?: string, max_items?: number)

List event types and record each as a data artifact (capped at 200 by default; writes a event_type_lookup record with the coverage of the walk)

Argument	Type	Required	Description
schema_id?	string	no	A string parameter filtering the results to return only the Event Types using a given schema.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the event_type_lookup record reports truncated: true.

fn sync()

Sync event type state from Twilio

Resources

state(infinite)— Event type resource state

event_type_lookup(infinite)— Event type lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/events/schema-versionv2026.08.25.2schema_version.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
id	string	yes	Path scope for the schema version: id
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a schema version

Argument	Type	Required	Description
id	string	yes	The schema_version of the schema version

fn lookup(max_items?: number)

List schema versions and record each as a data artifact (capped at 200 by default; writes a schema_version_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the schema_version_lookup record reports truncated: true.

fn sync()

Sync schema version state from Twilio

Resources

state(infinite)— Schema version resource state

schema_version_lookup(infinite)— Schema version lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/events/schemasv2026.08.25.1schemas.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
id	string	yes	Path scope for the schemas: id
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a schemas

Argument	Type	Required	Description
id	string	yes	The id of the schemas

fn sync()

Sync schemas state from Twilio

Resources

state(infinite)— Schemas resource state

@keeb/twilio/events/sinkv2026.08.25.2sink.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description	string	yes	A human readable description for the Sink This value should not contain PII.
sink_configuration	string	yes	The information required for Twilio to connect to the provided Sink encoded as JSON.
sink_type	enum	yes	The Sink type. Can only be "kinesis" or "webhook" currently.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a sink

fn get(id: string)

Get a sink

Argument	Type	Required	Description
id	string	yes	The sid of the sink

fn lookup(in_use?: boolean, status?: string, max_items?: number)

List sinks and record each as a data artifact (capped at 200 by default; writes a sink_lookup record with the coverage of the walk)

Argument	Type	Required	Description
in_use?	boolean	no	A boolean query parameter filtering the results to return sinks used/not used by a subscription.
status?	string	no	A String query parameter filtering the results by status `initialized`, `validating`, `active` or `failed`.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sink_lookup record reports truncated: true.

fn update()

Update sink attributes

fn delete(id: string)

Delete the sink

Argument	Type	Required	Description
id	string	yes	The sid of the sink

fn sync()

Sync sink state from Twilio

Resources

state(infinite)— Sink resource state

sink_lookup(infinite)— Sink lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/events/sink-testv2026.08.25.1sink_test.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
sid	string	yes	Path scope for the sink test: sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a sink test

Resources

state(infinite)— Sink test resource state

@keeb/twilio/events/sink-validatev2026.08.25.1sink_validate.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
sid	string	yes	Path scope for the sink validate: sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
test_id	string	yes	A 34 character string that uniquely identifies the test event for a Sink being validated.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a sink validate

Resources

state(infinite)— Sink validate resource state

@keeb/twilio/events/subscribed-eventv2026.08.25.2subscribed_event.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
subscription_sid	string	yes	Path scope for the subscribed event: subscription_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
schema_version?	number	no	The schema version that the Subscription should use.
type	string	yes	Type of event being subscribed to.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a subscribed event

fn get(id: string)

Get a subscribed event

Argument	Type	Required	Description
id	string	yes	The type of the subscribed event

fn lookup(max_items?: number)

List subscribed events and record each as a data artifact (capped at 200 by default; writes a subscribed_event_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the subscribed_event_lookup record reports truncated: true.

fn update()

Update subscribed event attributes

fn delete(id: string)

Delete the subscribed event

Argument	Type	Required	Description
id	string	yes	The type of the subscribed event

fn sync()

Sync subscribed event state from Twilio

Resources

state(infinite)— Subscribed event resource state

subscribed_event_lookup(infinite)— Subscribed event lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/events/subscriptionv2026.08.25.2subscription.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description	string	yes	A human readable description for the Subscription This value should not contain PII.
sink_sid	string	yes	The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created.
types	array	yes	An array of objects containing the subscribed Event Types
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a subscription

fn get(id: string)

Get a subscription

Argument	Type	Required	Description
id	string	yes	The sid of the subscription

fn lookup(sink_sid?: string, max_items?: number)

List subscriptions and record each as a data artifact (capped at 200 by default; writes a subscription_lookup record with the coverage of the walk)

Argument	Type	Required	Description
sink_sid?	string	no	The SID of the sink that the list of Subscriptions should be filtered by.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the subscription_lookup record reports truncated: true.

fn update()

Update subscription attributes

fn delete(id: string)

Delete the subscription

Argument	Type	Required	Description
id	string	yes	The sid of the subscription

fn sync()

Sync subscription state from Twilio

Resources

state(infinite)— Subscription resource state

subscription_lookup(infinite)— Subscription lookup coverage — whether the page walk exhausted the collection

04Stats

85 / 100

Downloads

Archive size

35.5 KB

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository0/2missing

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#twilio #events #communications #saas