Your AWS SES. Your dedicated Mailat. See how it works
Documentation

Create Webhook Trigger

Request, response and authentication details for your Mailat instance.

← All API operations
POST/api/v1/webhook-triggers

CreateWebhookTrigger creates a new webhook trigger POST /api/v1/webhook-triggers User-owned subscriptions. Secret returned only on create/rotate. Events: version,id,type,createdAt,data.messageUuid (+data.identityUuid where available). Verify X-Webhook-Signature t=<unix>,v1=<HMAC-SHA256(timestamp+'.'+rawBody)> with 5-minute timestamp tolerance; deduplicate id. 8 delivery attempts, then dead letter; replay keeps event id. Tests return real HTTP outcome. Key revocation does not delete subscriptions; disabled owners pause delivery. Public HTTPS only; redirects are blocked.

Authentication & compatibility

Use a scoped bearer API key with webhooks:manage. The key is bound to its user and organization.

Mailat application, account or shared resource API. Individual operations can require configured external services; this label is not a runtime-readiness guarantee.

Contract 2026-10-04. Your running instance's /api/v1/openapi.json is authoritative for its deployed release.

Request

Set MAILAT_BASE_URL to your instance origin (without /api/v1) and MAILAT_TOKEN to an appropriate credential. Replace path placeholders and example data before running. These examples do not execute in this page.

cURL request
curl --request POST "$MAILAT_BASE_URL/api/v1/webhook-triggers" \
  --header "Authorization: Bearer $MAILAT_TOKEN" \
  --header 'Content-Type: application/json' \
  --data @request.json

Build the request from the schema below; request.json and upload paths are local placeholders.

Request body (required)

application/json

bodyobjectrequired
Fields · service.CreateWebhookTriggerInput
activeboolean
descriptionstring
filtersobject
Additional valuesany value
namestringrequired
triggerTypestringrequired

Use a canonical dotted event name. Legacy underscored aliases are accepted; webhook.test is emitted only by the test endpoint.

Allowed: "email.received" | "email.sent" | "email.delivered" | "email.failed" | "email.unknown" | "email.bounced" | "email.complained" | "email_received" | "email_sent" | "email_delivered" | "email_failed" | "email_unknown" | "email_bounced" | "email_complained" | "bounce_received" | "complaint_received"

webhookUrlstring (uri)required

Public HTTPS only, at most 2048 bytes; no credentials/fragments/private or reserved destinations. Redirects are rejected.

Responses

HTTP statuses and body shapes below come from the pinned contract. Not every shared error applies to every request. Retain the original idempotency key when retrying a send.

201 · Success
Header: X-RateLimit-Remaininginteger

Remaining requests in this API key's current minute window (present for API-key authentication).

minimum: 0

application/json

responseobject
Fields
codeintegerrequired
dataall of · nullable
Variant 1object
Fields · service.WebhookTrigger
activeboolean
createdAtstring (date-time)
descriptionstring
filtersobject
Additional valuesany value
idinteger (int64)
lastTriggeredAtall of · nullable
Variant 1string (date-time)
namestring
orgIdinteger (int64)
secretstring
triggerCountinteger (int64)
triggerTypestring
updatedAtstring (date-time)
userIdinteger (int64)
uuidstring
webhookUrlstring
messagestringrequired
400 · Invalid input

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
401 · Missing, expired or revoked authentication

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
403 · Insufficient permission

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
404 · Resource not found

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
409 · Conflict or changed idempotency payload

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
410 · Recovery cursor expired; resynchronize

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
429 · Rate limit exceeded; respect Retry-After
Header: Retry-Afterinteger

Seconds until the next fixed-minute request window.

minimum: 1

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
500 · Internal failure; retain the idempotency key

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
Download the full OpenAPI contract