Integrate API
Home
Company
Company
  • Company
  • Users
  • Office
Orders
Orders
  • Orders
  • Change Request
  • Drafts
  • GoToScan
Webhooks
Home
Company
Company
  • Company
  • Users
  • Office
Orders
Orders
  • Orders
  • Change Request
  • Drafts
  • GoToScan
Webhooks
  1. Webhooks
  • About webhooks
  • Update company webhooks
    PATCH
  • /Order status
  1. Webhooks

About webhooks

You can register / update your webhook endpoints with cubicasa system via this endpoint Update delivery webhooks. Old webhooks are replaced with the new ones.
When a webhook is triggered, the webhook will send a POST to your webhook
URL and contain the following data about the order:
{
  "id": "363c38cd-9682-4ff3-9100-9ef4e755f275",
  "current_status": "Ready",
  "previous_status": "Pending",
  "model_id": "cb2aba10-979f-461c-bdb7-906f5047d111",
  "product_type": "products_2d",
  "delivery_type": "new"
}

There are 5 different states of order status#

StatusDescription
NewThe first initial state of order
DraftWhen order is created as draft
PendingWhen order is in production line
ReadyWhen order is ready to deliver
FixingWhen order is back to production line for fixing

In "Ready" status:#

You can use the "product_type" define the update for which order product
products_2d : Listing floorplans, gla, ....
products_3d : 3D floorplans, 3D video, CAD Files, ....
tour : Cubicasa tour
You can use the "previous_status" define the type of update the order received:
Pending: First delivery
Fixing: Fix request was delivered
Ready: Quick Edit was used to make a change

You can add 5 different webhook trigger types:#

Trigger typeWhen triggered
moved_to_draftOnce a draft order is created
moved_to_pendingOnce an order is uploaded – can be a draft order or made from scratch
moved_to_readyOnce order is ready – can be first delivery or order update
moved_to_fixingOnce a fix request is made
moved_to_failedIf order delivery is failed (not a supported status yet)
Note: We'll try to call your webhook for 3 times and then give up.
Modified at 2025-08-11 11:38:10
Next
Update company webhooks
Built with