Webhooks

Create a webhook endpoint

post/webhooks

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
eventsWebhookEventType[]

Defaults to all supported events if omitted

tenantsstring[] nullable

Only email events of these tenants (external_id or id). Such an endpoint gets no email.received, contact.* or automation.* events. [] or null removes the filter (every event).

Response

Webhook created (signing secret shown once)

secretstring required

Signing secret (whsec_…), shown once at creation

Changes

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