Skip to content

Webhooks

See Webhooks for the request simmail sends, signatures, retries and every event type.

CallWhat it does
GET /api/webhooksThe webhooks. Secrets are shown as ••••.
PUT /api/webhooksReplaces all webhooks with the list you send. Answers with the new list.

Changing webhooks needs the admin role and the webhooks feature of your plan (402 without it).

A webhook:

{
"name": "CI listener",
"url": "https://hooks.yourcompany.test/simmail",
"events": ["persona.*", "link.opened"],
"secret": "a-long-random-secret"
}

To keep an existing secret when you change a webhook, send "secret": "••••" with the same url. To remove all webhooks, send [].