set_mailbox_webhook
Set an HTTPS webhook URL for a mailbox to receive POST requests on every new inbound message, so agents avoid polling. A signing secret enables HMAC-SHA256 payload verification.
Instructions
Set or update the URL that fires on every new inbound message to this mailbox - the way an agent finds out about new mail without polling list_messages. Must be https. Returns a signing secret the FIRST time it's set (or if regenerateSecret is passed) - shown once, not recoverable later. Every delivery is a POST with an X-Mektup-Signature: sha256= header, an HMAC-SHA256 of the raw JSON body using that secret - verify it before trusting a payload.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | https:// URL to POST new-mail events to | |
| domain | Yes | A domain, e.g. example.com | |
| localPart | Yes | The part before @, e.g. "hello" for hello@example.com | |
| regenerateSecret | No | Issue a new signing secret even if one already exists - invalidates the old one |