Twilio/monitor
@keeb/twilio/monitorv2026.08.25.2
01README
Twilio monitor API models
02Release Notes
- Updated: alarm, alert, event
03Models
@keeb/twilio/monitor/alarmv2026.08.25.2alarm.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name | string | Friendly name for alarm |
| query_type | enum | Type of query |
| query? | string | Value to query for |
| trigger_value | number | Threshold to send customer alarm notification |
| time_window | enum | Time window for alarm to trigger |
| email? | array | Email notifications to send |
| webhook? | string | Webhook notification to send |
| console_indicator? | boolean | Whether to send console notifications |
| description | string | Description for the alarm. |
| enabled | boolean | Is alarm enbled? Default is true. |
| auth_token? | string | 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 | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | 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 alarm
fn get(id: string)
Get a alarm
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the alarm |
fn lookup(sort_order?: enum, max_items?: number)
List alarms and record each as a data artifact (capped at 200 by default; writes a alarm_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| sort_order? | enum | |
| max_items? | number | 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 alarm_lookup record reports truncated: true. |
fn update()
Update alarm attributes
fn delete(id: string)
Delete the alarm
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the alarm |
fn sync()
Sync alarm state from Twilio
fn update_status(sid: string, enabled: boolean)
Update status of alarm between enabled and disabled
| Argument | Type | Description |
|---|---|---|
| sid | string | Path parameter: sid |
| enabled | boolean | status of alarm |
Resources
state(infinite)— Alarm resource state
alarm_lookup(infinite)— Alarm lookup coverage — whether the page walk exhausted the collection
alarm_action(ephemeral)— Alarm action result
@keeb/twilio/monitor/alertv2026.08.25.2alert.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | 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 | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | 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 alert
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the alert |
fn lookup(log_level?: string, start_date?: string, end_date?: string, max_items?: number)
List alerts and record each as a data artifact (capped at 200 by default; writes a alert_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| log_level? | string | Only show alerts for this log-level. Can be: `error`, `warning`, `notice`, or `debug`. |
| start_date? | string | Only include alerts that occurred on or after this date and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported. |
| end_date? | string | Only include alerts that occurred on or before this date and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported. |
| max_items? | number | 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 alert_lookup record reports truncated: true. |
fn sync()
Sync alert state from Twilio
Resources
state(infinite)— Alert resource state
alert_lookup(infinite)— Alert lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/monitor/eventv2026.08.25.2event.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | 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 | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | 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
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the event |
fn lookup(actor_sid?: string, event_type?: string, resource_sid?: string, source_ip_address?: string, start_date?: string, end_date?: string, max_items?: number)
List events and record each as a data artifact (capped at 200 by default; writes a event_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| actor_sid? | string | Only include events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials. |
| event_type? | string | Only include events of this [Event Type](https://www.twilio.com/docs/usage/monitor-events#event-types). |
| resource_sid? | string | Only include events that refer to this resource. Useful for discovering the history of a specific resource. |
| source_ip_address? | string | Only include events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console. |
| start_date? | string | Only include events that occurred on or after this date. Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. |
| end_date? | string | Only include events that occurred on or before this date. Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. |
| max_items? | number | 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_lookup record reports truncated: true. |
fn sync()
Sync event state from Twilio
Resources
state(infinite)— Event resource state
event_lookup(infinite)— Event lookup coverage — whether the page walk exhausted the collection
04Stats
B
85 / 100
Downloads
0
Archive size
24.4 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