Cloudflare/alerting
@swamp/cloudflare/alertingv2026.11.16.1
01README
Cloudflare alerting infrastructure models
02Release Notes
- Updated: webhooks
03Behaviors
@swamp/cloudflare/alerting/policiesv2026.11.11.1policies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| alert_interval? | string | Optional specification of how often to re-alert from the same incident, not support on all alert types. |
| alert_type? | enum | Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. This enum lists every alert type, not the ones a given account can create, since some types depend on entitlements or account type. To get the alert types an account can create, call `GET /accounts/{account_id}/alerting/v3/available_alerts`. |
| description? | string | Optional description for the Notification policy. |
| enabled? | boolean | Whether or not the Notification policy is enabled. |
| filters? | object | Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details. |
| mechanisms? | object | List of IDs that will be used when dispatching a notification. IDs for email type will be the email address. |
| name? | string | Name of the policy. |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Policies
fn get(id: string)
Get a Policies
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Policies |
fn lookup(allowMissing?: boolean)
Look up an existing Policies by matching global argument values and import it into state
| Argument | Type | Description |
|---|---|---|
| allowMissing? | boolean | Succeed and record found: false in lookupResult when nothing matches, instead of failing |
fn adopt(id: string)
Import an existing Policies by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Policies to import |
fn update(identifier?: string)
Update Policies attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Policies by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Policies
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Policies |
fn sync(identifier?: string)
Sync Policies state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Policies by id (e.g. one discovered by list) |
Resources
state(infinite)— Policies resource state
lookupResult(infinite)— Outcome of the most recent lookup
@swamp/cloudflare/alerting/webhooksv2026.11.16.1webhooks.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name? | string | The name of the webhook destination. This will be included in the request body when you receive a webhook notification. |
| secret? | string | Optional secret that will be passed in the `cf-webhook-auth` header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body. Sensitive: wire with a vault.get(...) expression to source it from a vault. |
| url? | string | The POST endpoint to call when dispatching a notification. |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Webhooks
fn get(id: string)
Get a Webhooks
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Webhooks |
fn lookup(allowMissing?: boolean)
Look up an existing Webhooks by matching global argument values and import it into state
| Argument | Type | Description |
|---|---|---|
| allowMissing? | boolean | Succeed and record found: false in lookupResult when nothing matches, instead of failing |
fn adopt(id: string)
Import an existing Webhooks by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Webhooks to import |
fn update(identifier?: string)
Update Webhooks attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Webhooks by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Webhooks
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Webhooks |
fn sync(identifier?: string)
Sync Webhooks state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Webhooks by id (e.g. one discovered by list) |
Resources
state(infinite)— Webhooks resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.11.14.1AGPL-3.0-or-later
- Updated: webhooks
2026.11.11.1AGPL-3.0-or-later
- Updated: policies
2026.10.23.1AGPL-3.0-or-later
- Updated: webhooks
- Updated: policies
2026.10.20.1AGPL-3.0-or-later
- Updated: webhooks
- Updated: policies
Modified 2 behaviors
2026.10.16.1AGPL-3.0-or-later(was none)
2026.10.13.1
- Updated: webhooks
- Updated: policies
2026.09.29.2
- Updated: webhooks
- Updated: policies
2026.09.29.1
- Updated: webhooks
- Updated: policies
2026.09.25.1
- Updated: policies
2026.07.21.1
- Updated: webhooks
- Updated: policies
2026.07.18.2
Added 2, removed 1 behaviors
2026.06.08.2
- Updated: webhooks
- Updated: policies
2026.05.29.1
- Updated: webhooks
- Updated: policies
2026.05.22.1
- Added: webhooks
- Added: policies
05Stats
A
100 / 100
Downloads
35
Archive size
20.9 KB
Verified by Swamp
- 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
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels