Skip to main content
← back to extensions

Twilio/notify

@keeb/twilio/notifyv2026.08.25.2· 16d agoMODELS
01README

Twilio notify API models

02Release Notes
  • Updated: binding, credential, service
03Models4
@keeb/twilio/notify/bindingv2026.08.25.2binding.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sidstringPath scope for the binding: service_sid
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
identitystringThe `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service.
binding_typeenumThe transport technology to use for the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.
addressstringThe channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.
tag?arrayA tag that can be used to select the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 20 tags.
notification_protocol_version?stringThe protocol version to use to send the notification. This defaults to the value of `default_xxxx_notification_protocol_version` for the protocol in the [Service](https://www.twilio.com/docs/notify/api/service-resource). The current version is `"3"` for `apn`, `fcm`, and `gcm` type Bindings. The par
credential_sid?stringThe SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applies to only `apn`, `fcm`, and `gcm` type Bindings.
endpoint?stringDeprecated.
auth_token?stringTwilio 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?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio 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 binding
fn get(id: string)
Get a binding
ArgumentTypeDescription
idstringThe sid of the binding
fn lookup(start_date?: string, end_date?: string, identity?: string, tag?: string, max_items?: number)
List bindings and record each as a data artifact (capped at 200 by default; writes a binding_lookup record with the coverage of the walk)
ArgumentTypeDescription
start_date?stringOnly include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`.
end_date?stringOnly include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`.
identity?stringThe [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read.
tag?stringOnly list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.
max_items?numberStop 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 binding_lookup record reports truncated: true.
fn delete(id: string)
Delete the binding
ArgumentTypeDescription
idstringThe sid of the binding
fn sync()
Sync binding state from Twilio

Resources

state(infinite)— Binding resource state
binding_lookup(infinite)— Binding lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/notify/credentialv2026.08.25.2credential.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
friendly_name?stringA descriptive string that you create to describe the resource. It can be up to 64 characters long.
certificate?string[APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
private_key?string[APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\\n.-----END RSA PRIVATE KEY-----`
sandbox?boolean[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
api_key?string[GCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
secret?string[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
typeenumThe Credential type. Can be: `gcm`, `fcm`, or `apn`.
auth_token?stringTwilio 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?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio 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 credential
fn get(id: string)
Get a credential
ArgumentTypeDescription
idstringThe sid of the credential
fn lookup(max_items?: number)
List credentials and record each as a data artifact (capped at 200 by default; writes a credential_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop 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 credential_lookup record reports truncated: true.
fn update()
Update credential attributes
fn delete(id: string)
Delete the credential
ArgumentTypeDescription
idstringThe sid of the credential
fn sync()
Sync credential state from Twilio

Resources

state(infinite)— Credential resource state
credential_lookup(infinite)— Credential lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/notify/notificationv2026.08.25.1notification.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sidstringPath scope for the notification: service_sid
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
body?stringThe notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification.
priority?enumThe priority of the notification. Can be: `low` or `high` and the default is `high`. A value of `low` optimizes the client app's battery consumption; however, notifications may be delivered with unspecified delay. For FCM and GCM, `low` priority is the same as `Normal` priority. For APNS `low` prior
ttl?numberHow long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted
title?stringThe notification title. For FCM and GCM, this translates to the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices.
sound?stringThe name of the sound to be played for the notification. For FCM and GCM, this Translates to `data.twi_sound`. For APNS, this translates to `aps.sound`. SMS does not support this property.
action?stringThe actions to display for the notification. For APNS, translates to the `aps.category` value. For GCM, translates to the `data.twi_action` value. For SMS, this parameter is not supported and is omitted from deliveries to those channels.
data?stringThe custom key-value pairs of the notification's payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of
apn?stringThe APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS docu
gcm?stringThe GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. Target parameters `to`, `registrat
sms?stringThe SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/quickstart) resource. These parameters of the Message resource are
facebook_messenger?stringDeprecated.
fcm?stringThe FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`,
segment?arrayThe Segment resource is deprecated. Use the `tag` parameter, instead.
alexa?stringDeprecated.
to_binding?arrayThe destination address specified as a JSON string. Multiple `to_binding` parameters can be included but the total size of the request entity should not exceed 1MB. This is typically sufficient for 10,000 phone numbers.
delivery_callback_url?stringURL to send webhooks.
identity?arrayThe `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Delivery will be attempted only to Bindings with an Identity in this list. No more than 20 items
tag?arrayA tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to
auth_token?stringTwilio 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?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio 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 notification

Resources

state(infinite)— Notification resource state
@keeb/twilio/notify/servicev2026.08.25.2service.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
friendly_name?stringA descriptive string that you create to describe the resource. It can be up to 64 characters long.
apn_credential_sid?stringThe SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
gcm_credential_sid?stringThe SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
messaging_service_sid?stringThe SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
facebook_messenger_page_id?stringDeprecated.
default_apn_notification_protocol_version?stringThe protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
default_gcm_notification_protocol_version?stringThe protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
fcm_credential_sid?stringThe SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
default_fcm_notification_protocol_version?stringThe protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
log_enabled?booleanWhether to log notifications. Can be: `true` or `false` and the default is `true`.
alexa_skill_id?stringDeprecated.
default_alexa_notification_protocol_version?stringDeprecated.
delivery_callback_url?stringURL to send delivery status callback.
delivery_callback_enabled?booleanCallback configuration that enables delivery callbacks, default false
auth_token?stringTwilio 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?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio 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 service
fn get(id: string)
Get a service
ArgumentTypeDescription
idstringThe sid of the service
fn lookup(friendly_name?: string, max_items?: number)
List services and record each as a data artifact (capped at 200 by default; writes a service_lookup record with the coverage of the walk)
ArgumentTypeDescription
friendly_name?stringThe string that identifies the Service resources to read.
max_items?numberStop 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 service_lookup record reports truncated: true.
fn update()
Update service attributes
fn delete(id: string)
Delete the service
ArgumentTypeDescription
idstringThe sid of the service
fn sync()
Sync service state from Twilio

Resources

state(infinite)— Service resource state
service_lookup(infinite)— Service lookup coverage — whether the page walk exhausted the collection
04Stats
B
85 / 100
Downloads
0
Archive size
37.2 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
06Labels
#twilio#notify#communications#saas