Skip to Content

The MessageWebhookBody type of the TypeScript SDK, which mailboxes.setMessageWebhook take or answer.

type MessageWebhookBody = {
  format?: ('parsed' | 'reference')
  secret?: string | null
  url: string
}

Fields

FieldTypeDescription
format('parsed' | 'reference')Optional. The payload shape. Omit to keep (parsed for a new webhook); reference needs a deployment that mints capability URLs (400 webhook_format_unavailable)
secretstring | nullOptional. HMAC signing secret, write-only. Omit to keep the stored one, a string to set or rotate it, null to clear it (unsigned)
urlstringHTTPS endpoint on a public host

Used by

MethodWhat it does
mailboxes.setMessageWebhookCreate or replace the mailbox's message webhook

On this page