Skip to content

docs: document per-inbox webhooks#5

Open
armandokun wants to merge 1 commit into
feat/openapi-inbox-domain-paramfrom
feat/per-inbox-webhooks
Open

docs: document per-inbox webhooks#5
armandokun wants to merge 1 commit into
feat/openapi-inbox-domain-paramfrom
feat/per-inbox-webhooks

Conversation

@armandokun

Copy link
Copy Markdown
Collaborator

Stacked on #3 (base: feat/openapi-inbox-domain-param). Review/merge that first.

Summary

  • OpenAPI: add webhookUrl on create/update, webhookUrl/webhookSecret on the Inbox schema, and the rotate-secret and test webhook endpoints; regenerate the spec.
  • Concept docs: explain account vs. per-inbox webhooks and the WebSocket → inbox → account resolution order; link from the inboxes page.

Why

Companion to openmailsh/openmail#98 (per-inbox webhooks). Documents the new capability for the Matagi/Aleks use case.

Test plan

  • node scripts/generate-openapi.js runs clean; spec includes the new fields/paths
  • mint broken-links (CLI not installed locally)

Made with Cursor

Add per-inbox webhook fields and endpoints to the OpenAPI generator
(webhookUrl on create/update, webhookUrl/webhookSecret on the Inbox
schema, rotate-secret and test endpoints) and regenerate the spec.

Explain account vs. per-inbox webhooks and the WebSocket → inbox →
account resolution order in the webhooks concept page, and link it from
the inboxes page.

Co-authored-by: Cursor <cursoragent@cursor.com>
@armandokun armandokun mentioned this pull request Jun 1, 2026
2 tasks
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.

1 participant