Webhook events and JSON payloads reference

For server administrators · Updated 2026-10-29

On this page
  1. The envelope
  2. Events
  3. Examples
  4. Good to know

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. owner is the reseller's username, or null for the administrator's own accounts.

Events

EventWhenExtra fields in data
account.createdAn account was created (it is ready a moment later)package, email
account.suspendedAn account was suspendedreason
account.unsuspendedAn account was unsuspended—
account.terminatedAn account was deleted—
account.changedPackage or contact email changedpackage, email
account.changedMain domain changed (account.domain is the new one)old_domain
account.changedUsername changed (account.username is the new one)old_username
account.passwordAn administrator, reseller or the API set a new account password—
domain.addedAn addon domain, subdomain or alias was addeddomain, type (addon, subdomain or alias)
domain.removedA domain was removeddomain
domain.movedAn addon domain moved to another accountdomain, to (username, domain)
email.createdA mailbox was createdaddress
email.deletedA mailbox was deletedaddress
disk.limitThe account reached 90% or 100% of its disk (once a month each)used_mb, limit_mb
bandwidth.limitThe account used up its monthly bandwidth (once a month)used_mb, limit_mb
task.failedA server task failed, for example creating an accounttask, id, error
ticket.openedA customer opened a support ticketticket, subject
ticket.repliedA customer replied to a support ticketticket, 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.password is not sent when customers change their own password in the control panel.
  • The X-Sahaab-Event header repeats the event name, so you can route messages before parsing the body.
Was this article helpful?

Still stuck?

Ask the AI about your exact situation — it answers from this knowledge base — or contact us.