Skip to content

Add webhook custom delivery headers to docs and SDKs - #196

Draft
mikesteroonie wants to merge 2 commits into
mainfrom
agent/webhook-custom-headers
Draft

Add webhook custom delivery headers to docs and SDKs#196
mikesteroonie wants to merge 2 commits into
mainfrom
agent/webhook-custom-headers

Conversation

@mikesteroonie

@mikesteroonie mikesteroonie commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add the optional headers map to organization-, pod-, and inbox-scoped webhook creation
  • add typed GET .../headers and PATCH .../headers endpoints across all three SDK namespaces
  • document write-only header values, safe name inspection, atomic rotation, and removal

Why

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:

  • Python: get_headers() and update_headers()
  • TypeScript: getHeaders() and updateHeaders()
  • headers on webhook creation at organization, pod, and inbox scope

Validation

  • fern check: 0 errors; only pre-existing route-conflict warnings plus the existing FDR redirect-check warning
  • git diff --cached --check
  • local SDK generation reached both configured generators but could not execute because Docker is unavailable in the environment; repository release workflows will generate the SDKs from the validated Fern contract

@github-actions

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Jul 30, 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

Copy link
Copy Markdown

✨ 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-changelog-diff artifact or tag @fern Writer in #github-prs for changelog.

@github-actions

Copy link
Copy Markdown

✨ 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-changelog-diff artifact or tag @fern Writer in #github-prs for changelog.

@github-actions

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