Skip to content

Add docs for Http webhooks#212

Merged
danielgerlag merged 4 commits into
drasi-project:mainfrom
danielgerlag:http-webhooks
May 5, 2026
Merged

Add docs for Http webhooks#212
danielgerlag merged 4 commits into
drasi-project:mainfrom
danielgerlag:http-webhooks

Conversation

@danielgerlag
Copy link
Copy Markdown
Contributor

Add docs for Http webhooks

danielgerlag and others added 3 commits April 30, 2026 11:11
The HTTP source documentation was out of date with respect to the
upstream plugin README. This updates it to cover:

- Webhook Mode with configurable routes, Handlebars templates, and
  payload transformation for external services (GitHub, Shopify, etc.)
- Authentication options (HMAC signature verification, Bearer token)
- CORS configuration
- Template context variables and helpers
- Multi-format payload support (JSON, XML, YAML, text)
- Error behavior configuration (reject, acceptAndLog, acceptSilent)
- Timestamp auto-detection (seconds, ms, ns, ISO 8601)
- Response format documentation
- Adaptive batching throughput levels table
- Expanded troubleshooting section

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add detailed reference tables for all nested webhook configuration
objects: webhooks top-level, cors, routes, auth.signature, auth.bearer,
mappings, conditions (when), and element templates (node/relation).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Fix port default: 8080, not required (matches upstream)
- Fix Shopify example: template output property names should not be
  camel-cased (they are user-defined output, not config keys)
- Add note that 'when' conditions only support header/field, not
  route/query params
- Add note that dispatch_mode/dispatch_buffer_capacity are builder-only
  and not exposed in Drasi Server config
- Add note about /health returning status and features
- Add note about accessing Content-Type via headers context

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
These words are used in the updated HTTP source documentation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@danielgerlag danielgerlag merged commit fa07541 into drasi-project:main May 5, 2026
4 checks 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.

3 participants