Webhook events and JSON payloads reference
On this page
Each webhook message is a JSON POST with the same envelope. This page lists every event and what its data contains. To set up a webhook, see add a webhook.
The envelope
{
"event": "account.suspended",
"id": "ce2d9ae57d35fa63",
"time": "2026-10-20T10:04:47+00:00",
"server": "server1.example.com",
"data": {
"account": {"username": "shop1", "domain": "shop-example.com", "owner": "reseller1"},
"reason": "Unpaid invoice"
}
}
id— unique per message; the same on retries. Use it to ignore duplicates.time— when it happened, UTC.server— the server's hostname.data.account— the account concerned.owneris the reseller's username, ornullfor the administrator's own accounts.
Events
| Event | When | Extra fields in data |
|---|---|---|
account.created | An account was created (it is ready a moment later) | package, email |
account.suspended | An account was suspended | reason |
account.unsuspended | An account was unsuspended | — |
account.terminated | An account was deleted | — |
account.changed | Package or contact email changed | package, email |
account.changed | Main domain changed (account.domain is the new one) | old_domain |
account.changed | Username changed (account.username is the new one) | old_username |
account.password | An administrator, reseller or the API set a new account password | — |
domain.added | An addon domain, subdomain or alias was added | domain, type (addon, subdomain or alias) |
domain.removed | A domain was removed | domain |
domain.moved | An addon domain moved to another account | domain, to (username, domain) |
email.created | A mailbox was created | address |
email.deleted | A mailbox was deleted | address |
disk.limit | The account reached 90% or 100% of its disk (once a month each) | used_mb, limit_mb |
bandwidth.limit | The account used up its monthly bandwidth (once a month) | used_mb, limit_mb |
task.failed | A server task failed, for example creating an account | task, id, error |
ticket.opened | A customer opened a support ticket | ticket, subject |
ticket.replied | A customer replied to a support ticket | ticket, subject |
The Send test button sends ping with data {"message": "Test from <hostname>"} and no account.
Examples
account.created:
{"event": "account.created", "id": "a91f03c2b7d45e10", "time": "2026-10-20T10:00:00+00:00",
"server": "server1.example.com",
"data": {"account": {"username": "shop1", "domain": "shop-example.com", "owner": null},
"package": "Basic", "email": "[email protected]"}}
task.failed:
{"event": "task.failed", "id": "0c55e1f2a8b94d37", "time": "2026-10-20T10:01:12+00:00",
"server": "server1.example.com",
"data": {"account": {"username": "shop1", "domain": "shop-example.com", "owner": null},
"task": "account.create", "id": 1234, "error": "…"}}
data.id is the task number; see it in Task Queue or with GET /api/v1/jobs/{id}. A failed task that is not about one account has no data.account and goes only to the administrator's webhooks.
Good to know
- A reseller's webhooks receive only events of the reseller's own accounts.
account.passwordis not sent when customers change their own password in the control panel.- The
X-Sahaab-Eventheader repeats the event name, so you can route messages before parsing the body.
Thank you — this helps us improve the article.
Still stuck?
Ask the AI about your exact situation — it answers from this knowledge base — or contact us.
Related articles
- How to add a webhook (get notified when accounts change)
Send a signed JSON message to your billing, monitoring or chat system when an account is created, suspended or terminated, a mailbox is added and more.
- How to verify webhook signatures (HMAC-SHA256)
Check the X-Sahaab-Signature header of webhook messages with your signing secret, with code for PHP, Node.js and Python, and skip duplicates.
- REST API overview: authentication, requests and responses
How the REST API v1 works: base URL, Bearer token authentication, JSON or form bodies, the response envelope, HTTP status codes and every endpoint.