💡 Who can use it?
Customers who have enabled the Smartbuild Integration Add-on
Customers who have an IdeaRoom API Key
Post Frame, Red Iron, and Carport Customers
✅ Before you start
Make sure:
You have an IdeaRoom API Key. If you don't have an API Key, contact IdeaRoom support
You have the Smartbuild Integration Add-on configured and have confirmed it works
🔧 cURL Example
cURL example of how trigger "create job" via IdeaRoom's API:
curl --location --request PUT 'https://api.idearoom.com/v1/orders/ff84035098d54530222156b7af044975/smartbuild?forceOverride=true' \
--header 'client-id: carportview-cv-starter-norma' \
--header 'x-api-key: <PLACE API KEY HERE>' \
--header 'Content-Type: application/json' \
--data '{}'
ff84035098d54530222156b7af044975: is the hash of the IdeaRoom order. Each order will have its own unique hash (it is identifier of the order)forceOverride: query param means that even if we already have a smartbuild job associated with the order we will generate a new jobclient-id:is the supplier/vendor key. If you don't know it, you can contact support.x-api-key
:This is the IdeaRoom API key. If you don't know it, you can contact support.