Copy page

Orders

Order create

Code
"topic": "order.create"

Occurs when an order is created on a Squarespace merchant site.

Read the Overview for details about the information sent with every Squarespace webhook notification.

Payment Plan orders fire order.create only when fully paid. To preserve backward compatibility with existing integrations, an order using a Payment Plan does not trigger order.create when the deposit is captured at checkout. The notification fires only when the order's paymentState transitions to PAID (all installments collected), which may be days, weeks, or months after the order was originally placed. To detect newly placed Payment Plan orders in real time, poll the retrieve all orders endpoint with paymentStates=PARTIALLY_PAID.

Request payload example

Code
{
  // String; unique notification id
  "id": "5c2ba184b63ed3cb411ce2b1",
  // String; Squarespace website id that triggered the notification.
  "websiteId": "5f3c3d55ac435e1a051f77b3",
  // String; unique Webhook Subscriptions id
  "subscriptionId": "5f3c2155d947844beedda991",
  // String; description of the event that triggered notification.
  "topic": "order.create",
  // ISO 8601 UTC date and time string; represents when the notification was created.
  "createdOn": "2020-04-22T22:18+00:00",
  // Object; data associated with the event.
  "data": {
    // String; unique order id.  
    "orderId": "5f3c39ce69e11e796f19990e"
  }
}