Skip to content

Fix inbound_inbox_id webhook field: optional, not required - #49

Open
mklocek wants to merge 1 commit into
mainfrom
fix-inbound-inbox-id-optional
Open

Fix inbound_inbox_id webhook field: optional, not required#49
mklocek wants to merge 1 commit into
mainfrom
fix-inbound-inbox-id-optional

Conversation

@mklocek

@mklocek mklocek commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

Corrects the inbound_inbox_id description on the create-webhook request. It was documented as required for inbound_receiving webhooks, but it is actually optional — omitting it applies the webhook to all inboxes in the account.

Change

specs/email-sending.openapi.yml, create-webhook request body:

ID of the inbound inbox the webhook is linked to. Required for Optional for inbound_receiving webhooks — omit to apply the webhook to all inboxes in the account. Not applicable to any other webhook type.

The inbound_inbox_id descriptions on the update-webhook request and the webhook response already read "Applicable only for inbound_receiving webhooks" and are unchanged.

Why

The misleading "required" wording propagated into the SDKs during backfill (PHP enforced it with a throw; Ruby/MCP documented it). All are being corrected; this fixes the source of truth.

Summary by CodeRabbit

  • New Features
    • Webhooks configured for inbound email receiving can now apply to all account inboxes by omitting the inbox selection.
    • Inbox selection remains unavailable for other webhook types.

inbound_inbox_id is optional for inbound_receiving webhooks; omitting it
applies the webhook to all inboxes in the account. It is not required.
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4b68070c-d51d-4f6b-803c-e7e6cd259b4b

📥 Commits

Reviewing files that changed from the base of the PR and between b2eacd2 and 11e543c.

📒 Files selected for processing (1)
  • specs/email-sending.openapi.yml

📝 Walkthrough

Walkthrough

The webhook creation schema now permits omitting inbound_inbox_id for inbound_receiving webhooks. Omission applies the webhook to all account inboxes. Other webhook types remain unaffected.

Changes

Inbound webhook scope

Layer / File(s) Summary
Webhook creation scope
specs/email-sending.openapi.yml
inbound_inbox_id is optional for inbound_receiving webhooks and remains inapplicable to other webhook types.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: i7an

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: making inbound_inbox_id optional for webhooks.
Description check ✅ Passed The description clearly explains the motivation and change, but it omits the template's How to test and Images and GIFs sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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