Webhooks

Set or update the mailbox's webhook

Fires (HMAC-SHA256 signed) on every new inbound message - one URL per mailbox, setting a new one replaces the old. Must be https.

put/v1/domains/{domain}/mailboxes/{localPart}/webhook

Request

  • Base URL: https://api.usemektup.com
  • URL: https://api.usemektup.com/v1/domains/{domain}/mailboxes/{localPart}/webhook
  • Auth: HTTP bearer

Path parameters

domainstring required
localPartstring required

Request body

urlstring uri required

Must be https://

regenerateSecretboolean

Issue a new signing secret, invalidating the old one

Response

OK

addressstring
urlstring uri
secretstring

Only present on first setup or when regenerateSecret was true - not recoverable later

Changes

No recorded changes to this operation across all 2 revisions of this API.