Loading...

Account & Alias ordering

Receive real-time webhooks tracking named account ordering and alias creation progress.


Account ordering notifications tell you when an asynchronous order reaches a terminal state — named account ordering and alias creation. See for enabling, testing, and delivery details common to all channels.

Both flows are asynchronous: you place an order and receive an order id immediately, then a notification is delivered once the order completes or fails.

Types of notifications

NotificationDescriptionX-Volt-Type header value
Named account order completedA named account was created successfully.named_account_order_completed
Named account order failedA named account order could not be completed.named_account_order_failed
Alias order completedAll aliases in an order were created successfully.alias_order_completed
Alias order failedAn alias order could not be completed.alias_order_failed

Configuration and overrides

Every order can override the destination URL per request by passing a communication field on the order request. For the general setup — Fuzebox configuration, the override payload, and delivery — see .

Ordering notifications are keyed by the order id (delivered in the notification metadata), not the resulting account or alias. The payload mirrors the order status resource, so it is identical to the GET order response.

Alias order

Sent when an alias order reaches a terminal state. Follow _links.aliases.href to fetch the aliases created by the order.

Prop

Type

{
  "id": "9f1b0c2e-7b3a-4d2c-8a11-2f6e5b9c1234",
  "accountId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "COMPLETED",
  "requested": 25,
  "completed": 25,
  "createdAt": "2026-06-25T10:00:00Z",
  "completedAt": "2026-06-25T10:00:12Z",
  "_links": {
    "self": {
      "href": "https://accounts.sandbox.volt.io/orders/account-aliases/9f1b0c2e-7b3a-4d2c-8a11-2f6e5b9c1234",
      "method": "GET"
    },
    "aliases": {
      "href": "https://accounts.sandbox.volt.io/accounts/f47ac10b-58cc-4372-a567-0e02b2c3d479/aliases?orderId=9f1b0c2e-7b3a-4d2c-8a11-2f6e5b9c1234",
      "method": "GET"
    }
  }
}

Named account order

Sent when a named account order reaches a terminal state. On completion, accountId references the newly created account. On failure, statusReason describes why.

Prop

Type

{
  "id": "2158b419-f435-48a9-bf57-decdb6d72ef6",
  "onboardingEntityId": "0fadd711-a97d-4b8e-87d1-cd240e5b5846",
  "status": "COMPLETED",
  "accountId": "ce862ef6-2313-40c0-b5e0-3328de199b9d",
  "createdAt": "2026-06-25T10:00:00Z",
  "completedAt": "2026-06-25T10:00:12Z"
}

Security and delivery

Ordering notifications share the standard Volt webhook envelope, signature, and retry behaviour — see .

How is this guide?

Last updated on

On this page