Skip to content

Document opt-in received envelope webhook contract - #236

Open
shalim786 wants to merge 1 commit into
mainfrom
agent/visa-envelope-docs-review
Open

shalim786 wants to merge 1 commit into
mainfrom
agent/visa-envelope-docs-review

Conversation

@shalim786

Copy link
Copy Markdown
Contributor

Adds the opt-in message.received.envelope webhook contract corresponding to agentmail-api PR #1209. The envelope has its own payload schema, because adding it to the full-content MessageReceivedEventType would incorrectly require message content and a thread object. The global subscription event enum includes the new type, and the webhook catalog exposes the separate payload.

Documents cohort-only permission checks, missing authentication-result semantics, metadata limits, and the console/WebSocket activation limitations without announcing general availability or claiming an SDK release.

Validation: pinned Fern 5.44.8 check passed with zero errors; 25 warnings concern existing route overlaps and an unauthenticated redirect check. MCP tool catalog check and git diff check passed.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

📋 View the side-by-side API change review

The link expires in 7 days.

🔒 Your API specs are encrypted in CI before they're uploaded. The decryption key stays in this link's URL fragment (after the #), which browsers never send to a server, so oasdiff cannot read your specs. How it works →

Posted automatically by the oasdiff GitHub Action. To turn this off (no spec upload, no comment), set review: false on the action.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

✨ API Changes

# API Changelog n/a vs. n/a


## API Changes

### GET /v0/inboxes/{inbox_id}/webhooks
- :warning: added the new `message.received.envelope` enum value to the `webhooks/items/event_types/items/` response property for the response status `200`


### POST /v0/inboxes/{inbox_id}/webhooks
- :warning: added the new `message.received.envelope` enum value to the `event_types/items/` response property for the response status `200`
-  added the new `message.received.envelope` enum value to the request property `event_types/items/`


### GET /v0/inboxes/{inbox_id}/webhooks/{webhook_id}
- :warning: added the new `message.received.envelope` enum value to the `event_types/items/` response property for the response status `200`


### PATCH /v0/inboxes/{inbox_id}/webhooks/{webhook_id}
- :warning: added the new `message.received.envelope` enum value to the `event_types/items/` response property for the response status `200`
-  added the new `message.received.envelope` enum value to the request property `event_types/items/`


### GET /v0/pods/{pod_id}/webhooks
- :warning: added the new `message.received.envelope` enum value to the `webhooks/items/event_types/items/` response property for the response status `200`


### POST /v0/pods/{pod_id}/webhooks
- :warning: added the new `message.received.envelope` enum value to the `event_types/items/` response property for the response status `200`
-  added the new `message.received.envelope` enum value to the request property `allOf[subschema #1: webhooksCreateInboxWebhookRequest]/event_types/items/`


### GET /v0/pods/{pod_id}/webhooks/{webhook_id}
- :warning: added the new `message.received.envelope` enum value to the `event_types/items/` response property for the response status `200`


### PATCH /v0/pods/{pod_id}/webhooks/{webhook_id}
- :warning: added the new `message.received.envelope` enum value to the `event_types/items/` response property for the response status `200`
-  added the new `message.received.envelope` enum value to the request property `allOf[subschema #1: webhooksUpdateInboxWebhookRequest]/event_types/items/`


### GET /v0/webhooks
- :warning: added the new `message.received.envelope` enum value to the `webhooks/items/event_types/items/` response property for the response status `200`


### POST /v0/webhooks
- :warning: added the new `message.received.envelope` enum value to the `event_types/items/` response property for the response status `200`
-  added the new `message.received.envelope` enum value to the request property `allOf[subschema #1: webhooksCreatePodWebhookRequest]/allOf[subschema #1: webhooksCreateInboxWebhookRequest]/event_types/items/`


### GET /v0/webhooks/{webhook_id}
- :warning: added the new `message.received.envelope` enum value to the `event_types/items/` response property for the response status `200`


### PATCH /v0/webhooks/{webhook_id}
- :warning: added the new `message.received.envelope` enum value to the `event_types/items/` response property for the response status `200`
-  added the new `message.received.envelope` enum value to the request property `allOf[subschema #1: webhooksUpdatePodWebhookRequest]/allOf[subschema #1: webhooksUpdateInboxWebhookRequest]/event_types/items/`

💡 Download api-changelog-diff artifact or tag @fern Writer in #github-prs for changelog.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

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