Add webhook custom delivery headers to docs and SDKs - #196
Draft
mikesteroonie wants to merge 2 commits into
Draft
Conversation
📋 View the side-by-side API change reviewThe 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 |
✨ API Changes# API Changelog n/a vs. n/a
## API Changes
### POST /v0/inboxes/{inbox_id}/webhooks
- added the new optional request property `headers`
### GET /v0/inboxes/{inbox_id}/webhooks/{webhook_id}/headers
- endpoint added
### PATCH /v0/inboxes/{inbox_id}/webhooks/{webhook_id}/headers
- endpoint added
### POST /v0/pods/{pod_id}/webhooks
- added the new optional request property `allOf[subschema #1: webhooksCreateInboxWebhookRequest]/headers`
### GET /v0/pods/{pod_id}/webhooks/{webhook_id}/headers
- endpoint added
### PATCH /v0/pods/{pod_id}/webhooks/{webhook_id}/headers
- endpoint added
### POST /v0/webhooks
- added the new optional request property `allOf[subschema #1: webhooksCreatePodWebhookRequest]/allOf[subschema #1: webhooksCreateInboxWebhookRequest]/headers`
### GET /v0/webhooks/{webhook_id}/headers
- endpoint added
### PATCH /v0/webhooks/{webhook_id}/headers
- endpoint added💡 Download |
✨ API Changes# API Changelog n/a vs. n/a
## API Changes
### POST /v0/inboxes/{inbox_id}/webhooks
- added the new optional request property `headers`
### GET /v0/inboxes/{inbox_id}/webhooks/{webhook_id}/headers
- endpoint added
### PATCH /v0/inboxes/{inbox_id}/webhooks/{webhook_id}/headers
- endpoint added
### POST /v0/pods/{pod_id}/webhooks
- added the new optional request property `allOf[subschema #1: webhooksCreateInboxWebhookRequest]/headers`
### GET /v0/pods/{pod_id}/webhooks/{webhook_id}/headers
- endpoint added
### PATCH /v0/pods/{pod_id}/webhooks/{webhook_id}/headers
- endpoint added
### POST /v0/webhooks
- added the new optional request property `allOf[subschema #1: webhooksCreatePodWebhookRequest]/allOf[subschema #1: webhooksCreateInboxWebhookRequest]/headers`
### GET /v0/webhooks/{webhook_id}/headers
- endpoint added
### PATCH /v0/webhooks/{webhook_id}/headers
- endpoint added💡 Download |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
headersmap to organization-, pod-, and inbox-scoped webhook creationGET .../headersandPATCH .../headersendpoints across all three SDK namespacesWhy
The backend support shipped in agentmail-api PRs #710 and #728, but the Fern contract did not yet expose it to generated SDKs or API reference users. This change lets developers authenticate and route webhook deliveries without recreating endpoints, while keeping secret values out of read responses.
SDK impact
Generated clients gain:
get_headers()andupdate_headers()getHeaders()andupdateHeaders()headerson webhook creation at organization, pod, and inbox scopeValidation
fern check: 0 errors; only pre-existing route-conflict warnings plus the existing FDR redirect-check warninggit diff --cached --check