Charchy Senddocs

Account events

`account.paused` when sending is paused for your workspace (whoever paused it), `account.resumed` when it resumes, and `balance.low` when what you have left falls to 20% of what you had after your last top-up (`used_percent: 80`) and when it reaches zero (`100`) — once each per top-up. A top-up is a plan term starting, or credits added. Signed like every event.

account.paused when sending is paused for your workspace (whoever paused it), account.resumed when it resumes, and balance.low when what you have left falls to 20% of what you had after your last top-up (used_percent: 80) and when it reaches zero (100) — once each per top-up. A top-up is a plan term starting, or credits added. Signed like every event.

webhook-id*string

The event's id (evt_…), the same on every retry. Dedupe by it.

webhook-timestamp*string

Unix seconds when this attempt was signed. Reject if older than 5 minutes.

webhook-signature*string

One or more v1,<base64 HMAC-SHA256 of "id.timestamp.body">, separated by spaces (two during a secret rotation).

application/json
  1. body
id*string

Same as the webhook-id header.

created_at*string

When it happened. Order events by it.

Formatdate-time
test?boolean

Present and true on a sample from Send test event (no real email behind it). Whether a real email used a test key is data.test.

type*string
Value in"account.paused""account.resumed""balance.low"
data*

account.paused: code and reason. account.resumed: empty. balance.low: used_percent and emails_left.

Received.

Example Requests
POST/account-event
Request Body
application/json
{  "id": "evt_2b7k9x4m1q8w3n5p6r0s2t4v",  "created_at": "2019-08-24T14:15:22Z",  "type": "account.paused",  "data": {}}
Header Parameters
{  "webhook-id": "string",  "webhook-timestamp": "string",  "webhook-signature": "string"}