Using the Roomio API and webhooks

Created by Dean Kominek, Modified on Thu, 27 Aug at 9:36 PM by Dean Kominek

Getting an API key

  1. Sign in to the web portal at https://app.roomio.io.

  2. Go to the Developers section.

  3. Select API Keys.

  4. Click Create API key.

Full documentation is at https://docs.roomio.io.


Webhooks

Webhooks send your system an HTTP POST the moment something happens, so you do not have to poll for updates. You configure one or more endpoint URLs to receive them.


You can subscribe to these events:


Event

Fires when

floor_plan_order.submitted

A floor plan order is paid and submitted via the Roomio app

floor_plan_order.completed

A floor plan order has been completed by our designers

floor_plan_order.cancelled

An order is cancelled, or we have been unable to complete it

scan.uploaded

A scan is uploaded from the Roomio app

scan.failed

A scan could not be processed

amendment.requested

An amendment is requested against a completed floor plan order

amendment.completed

An amendment is completed

floor_plan.edited

Floor plan files are edited in the floor plan editor and regenerated


Events that do not complete successfully are retried automatically with exponential backoff. Retry behaviour is documented at https://docs.roomio.io/docs/webhooks/retries.


We recommend verifying that incoming webhooks are genuinely from Roomio. The security instructions are in the webhooks documentation: https://docs.roomio.io/docs/webhooks/introduction


Questions about a specific integration

Email support@roomio.io with what you are trying to build so we can discuss with our developers.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article