Order Create | Webhook Events - HoopAI Help Center

The OrderCreate event fires the moment a new order is submitted through a HoopAI store or funnel. The payload includes the full order details — contact, line items, pricing breakdown, tax summary, and the originating source — making it straightforward to trigger fulfillment workflows, notify warehouse systems, or record revenue in external platforms.

Payload

Field	Type	Description
`type`	`string`	Always `"OrderCreate"`
`locationId`	`string`	Account ID where the order was placed
`_id`	`string`	Unique identifier for the order
`altId`	`string`	Account (location) ID — matches `locationId`
`altType`	`string`	Resource type for `altId` — always `"location"`
`status`	`string`	Order payment status (e.g., `pending`, `completed`)
`fulfillmentStatus`	`string`	Shipping/fulfillment status (e.g., `unfulfilled`, `fulfilled`)
`contactId`	`string`	ID of the contact who placed the order
`contactSnapshot`	`object`	Point-in-time snapshot of the contact (id, locationId, firstName, lastName, email, phone, dnd, dateAdded)
`currency`	`string`	ISO 4217 currency code (e.g., `USD`)
`amount`	`number`	Total order amount including tax and shipping
`liveMode`	`boolean`	`true` when the event originates from a live account; `false` in test mode
`items`	`array`	Line items in the order, each containing name, quantity, and price details
`amountSummary`	`object`	Breakdown of the order total (subtotal, discount, tax, shipping)
`amountSummary.subtotal`	`number`	Pre-tax, pre-discount order subtotal
`amountSummary.discount`	`number`	Total discount applied to the order
`amountSummary.tax`	`number`	Total tax amount
`amountSummary.shipping`	`number`	Shipping charges
`taxSummary`	`array`	Per-tax-rule breakdown (id, name, calculation method, rate, amount)
`source`	`object`	Origin of the order (type, subType, id, name — e.g., a website store)
`createdAt`	`string`	ISO 8601 timestamp when the order was created
`updatedAt`	`string`	ISO 8601 timestamp of the most recent update

Example payload

{
  "type": "OrderCreate",
  "locationId": "Z4Bxl8J4SaPEPLq9IQ8g",
  "_id": "660ed43bfdf9fc05a0de7a40",
  "altId": "Z4Bxl8J4SaPEPLq9IQ8g",
  "altType": "location",
  "status": "pending",
  "fulfillmentStatus": "unfulfilled",
  "contactId": "ff2JstbQJfRuofXzeT0M",
  "currency": "USD",
  "amount": 150.1,
  "liveMode": false,
  "amountSummary": {
    "subtotal": 138,
    "discount": 0,
    "tax": 12.1,
    "shipping": 0
  },
  "taxSummary": [
    {
      "_id": "63770f5cecf298787c752075",
      "name": "10%",
      "calculation": "exclusive",
      "rate": 10,
      "amount": 12.1
    }
  ],
  "source": {
    "type": "website",
    "subType": "store",
    "id": "nohc1pPZJlpZTpxJfLCp",
    "name": "Ecom Store"
  },
  "createdAt": "2024-04-04T16:24:27.036Z",
  "updatedAt": "2024-04-04T16:24:31.297Z",
  "contactSnapshot": {
    "id": "ff2JstbQJfRuofXzeT0M",
    "locationId": "Z4Bxl8J4SaPEPLq9IQ8g",
    "firstName": "Maxwell",
    "lastName": "Schmidt",
    "email": "limof@mailinator.com",
    "phone": "+2389372075506",
    "dnd": false,
    "dateAdded": "2024-04-04T16:24:21.375Z"
  },
  "items": [
    {
      "name": "Men's classic tee - XL / Charcoal",
      "qty": 1,
      "price": {
        "_id": "660ed20095e1dcd37bb0d392",
        "name": "XL / Charcoal",
        "type": "one_time",
        "currency": "USD",
        "amount": 17
      }
    }
  ]
}

Order Status Update — fires when an order’s status changes
Payments API — query orders and transactions programmatically

​Payload

​Example payload

​Related

Payload

Example payload

Related