Skip to content

docs(notifications): Notifications guide (EN+ES), /v1/notification-channels in the API reference, current edge 401 text - #183

Merged
sre-helmcode merged 4 commits into
mainfrom
docs/notifications
Oct 14, 2026
Merged

sre-helmcode merged 4 commits into
mainfrom
docs/notifications

Conversation

@sre-helmcode

Copy link
Copy Markdown
Contributor

What

Docs for NaN community notifications (Agent Automations Phase 3, cloud-api #349 / 0.8.262, devops #839).

  • New page Notifications (/docs/notifications, ES /es/docs/notifications), nested under Automations right after Secrets: channels (Slack, Teams, Discord, HTTPS) and how to get each provider's webhook URL, events and defaults (run.finished opt-in, run.failed includes timed_out, only automation runs notify, cancelled runs never), digests and rate limits, retries and auto-disable (20 failures, invalid_url), re-enabling, verifying the HTTPS signature (bash, Python, Node; same scheme as inbound nan webhooks), payload schema v1 + digest + test (from the cloud-api golden files), security (URLs are credentials, url_hint, what a message never carries, URL rules), portal / CLI (nan notifications, nan-cli 0.1.34) / API with notifications:read and notifications:write, limits and troubleshooting.
  • Webhooks, Examples and Apps move one order slot down.
  • Links from Automations (intro, token scope table, browser-only list), Secrets and NaN CLI (EN + ES).
  • src/data/openapi.json: new Notifications tag with the nine /v1/notification-channels operations, schemas and the real error bodies; the scopes in the overview and the platform token scheme.
  • The token_not_valid_for_inference example now quotes the edge Worker's current text (devops cloudflare/api-edge-normaliser/src/index.js, origin/main 6e4f7588):
    • before: ... Platform tokens only work on the platform API (/v1/runs and GET /api/workspaces).
    • after: ... Platform tokens only work on the platform API (/v1/runs, /v1/automations, /v1/approvals, /v1/secrets, /v1/notification-channels and GET /api/workspaces).
      The OpenAPI overview was the only place the website quoted it (plus its test).

Tests

  • New src/tests/layouts/notificationsDocs.test.ts (page facts vs cloud-api constants and golden files copied to src/tests/fixtures/notifications, links and anchors, EN/ES parity, no internals or private data, the CLI never takes a URL argument) and src/lib/openapiNotifications.test.ts (operations, scopes, credential refusals, rate limits, every example validated against its schema, closed enums).
  • Updated nav order / nesting / prev-next tests and the OpenAPI surface tests.
  • npx vitest run: 86 files, 2524 tests passed. npm run build: OK.

Deploy notes

Static docs only. The CLI section documents nan-cli 0.1.34 (nan notifications), shipping in its own PR.

🤖 Generated with Claude Code

barckcode and others added 4 commits October 14, 2026 19:47
…nks from automations, secrets and nan-cli

Channels (Slack, Teams, Discord, HTTPS) and where to get each webhook URL,
events and defaults, digests and rate limits, auto-disable, verifying the
HTTPS signature, payload schema, security, portal/CLI/API management and
troubleshooting. Webhooks, Examples and Apps move one slot down.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…on scopes, current edge 401 message for platform tokens

Nine operations under a new Notifications tag (after Secrets), with schemas,
the real error bodies of cloud-api 0.8.262 and examples validated in tests.
The overview and the platform token scheme list notifications:read and
notifications:write. token_not_valid_for_inference now quotes the edge
Worker's current text (devops 6e4f7588), which names every platform route.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ff/on, Rotate secret, status badges, automation card)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…aveat, test vector, sturdier verify examples, provider links, missing error rows)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sre-helmcode
sre-helmcode merged commit 15404f7 into main Oct 14, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants