Skip to content

docs: README updates for queue support, Upstash QStash, examples, and API reference#49

Merged
Prateek32177 merged 2 commits intocodex/add-scalable-alerting-integration-for-slack-and-discordfrom
codex/update-readme-with-latest-code-and-features
Mar 3, 2026
Merged

docs: README updates for queue support, Upstash QStash, examples, and API reference#49
Prateek32177 merged 2 commits intocodex/add-scalable-alerting-integration-for-slack-and-discordfrom
codex/update-readme-with-latest-code-and-features

Conversation

@Prateek32177
Copy link
Contributor

Motivation

  • Document and advertise optional queue-based delivery with Upstash QStash, update examples to reflect handler metadata and safer request handling, and surface the new Upstash-related SDK helpers in the docs.
  • Clarify platform signature notes, update feature/error-code names, and improve troubleshooting and alerting documentation.

Description

  • Extended README.md navigation and added sections for Queue vs Non-Queue Delivery, Upstash Queue Setup, and DLQ-aware alerting with code examples showing queue: true usage and createTernControls usage.
  • Updated framework examples to include import/express.raw usage for Express, optional chaining for req.webhook, Next.js and Cloudflare handler signatures to accept metadata, and adjusted sample handler return shapes.
  • Updated API reference to document new exports and helpers for @hookflo/tern/upstash (including createTernControls, handleQueuedRequest, handleReceive, handleProcess, resolveQueueConfig), added an alias verifyTokenBased, added handleWithQueue, and changed WebhookVerificationResult.errorCode to a generic string type and renamed a timestamp error to TIMESTAMP_EXPIRED.

Testing

  • Documentation-only changes, so no automated tests were modified or required for this PR.

Codex Task

@Prateek32177 Prateek32177 merged commit 01a93a2 into codex/add-scalable-alerting-integration-for-slack-and-discord Mar 3, 2026
3 checks passed
@Prateek32177 Prateek32177 deleted the codex/update-readme-with-latest-code-and-features branch March 3, 2026 11:22
Prateek32177 added a commit that referenced this pull request Mar 3, 2026
…replay (#46)

* refactor: make controls.alert primary API for dlq and non-dlq alerts

* payload updated

* Fix missing alert context fields in Slack/Discord notifications (#47)

* Fix alert context propagation for Slack/Discord payloads

* Fix lint errors in notification internals exports

* payload updated

* Centralize alerts and restore backward-compatible payload defaults (#48)

* payload updated

* version upgraded

* updated readme

* updated readme

* docs: README updates for queue support, Upstash QStash, examples, and API reference (#49)

* docs: restore full README sections and keep queue updates

* docs: strengthen README positioning and core SDK usage

* updated readme

* updated readme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant