Open API, webhooks and mini-apps for building management software
When no ready-made link exists between Unitify and another system, the open API is the way in. It is the same interface the products themselves use, with public documentation.
This page covers the API, webhooks, mini-apps and sign-in from your own service: what each does, how to get access and what is set up per project.
Short answer
The GraphQL API, webhooks, mini-apps and OpenID Connect sign-in work today and are documented publicly. API access is part of the Pro plan. Giving a specific system or vendor access, and the work to map their data, is set up per project.
What this connection is for
Connect any system that can call an API
An accounting or ERP system, a metering platform, a chatbot or your own software reads and writes Unitify data.
React to changes
Webhooks tell your system when a request, a contact or an invoice changes, instead of your system asking over and over.
Build on the platform
A mini-app puts your service inside the admin panel or the resident app, so users never leave Unitify.
What data moves, and in which direction
Each line says whether it works today or is set up for your project.
- Works today
Read and write: GraphQL API
Buildings, apartments, contacts, requests, meter readings, news and invoices can be queried, created and updated. Billing and payment records carry an importId for the identifier from your system.
- Works today
Events out: webhooks
Subscriptions cover requests, contacts, organizations, documents and invoices, with the fields and filters you choose. An invoice can also call an address when its payment status changes.
- Works today
Inside the product: mini-apps
A web service runs in the admin panel or the resident app and talks to the host through the Bridge library.
- Works today
Sign-in: OpenID Connect
A service that provides OpenID Connect lets its users authorize against the Unitify API without a second password.
- Set up per project
Mapping and building the link
Deciding which of your fields map to which of ours, and building the exchange for your system.
How to get access
The documentation is public. The plan and access rights are the part we set up with you.
- Works today
Read the documentation
The domain model, authorization and examples are public.
Open the API documentation - Works today
Try it in a playground
The documentation includes a step-by-step playground tutorial for first queries.
Open the playground tutorial - Works today
Webhook addresses
Webhook subscriptions and addresses are set up by us. Ask, and we add yours.
Read the webhook example - Works today
Mini-apps and sign-in
Mini-apps use the Bridge library; sign-in from your own service uses OpenID Connect.
Open the Bridge documentation
What you provide
The use case
What your system needs to read or write, and how often.
A test organization
One organization to try the access on before it touches real data.
A contact on your side
Someone who can read API documentation and receive a webhook.
The honest limits
- API access is part of the Pro plan. The live pricing page has current plan details.
- No SAML. Sign-in from another service, for staff or residents, uses OpenID Connect, and we register your service as the provider.
- A link to your system is a project. The API makes it possible; mapping your data and building the exchange is work we scope with you.
Open API and webhooks: questions
Is there a public API?
Yes. The API is GraphQL, and its documentation is public: domain model, authorization, examples and a playground tutorial.
What can I read and write?
Buildings, apartments, contacts, requests, meter readings, news, invoices and more. Objects share the same way of being read, created and updated.
Are there webhooks?
Yes. Subscriptions cover requests, contacts, organizations, documents and invoices, and an invoice can call an address when its payment status changes. We set the subscription up for you.
Can my own service run inside Unitify?
Yes, as a mini-app in the admin panel or the resident app, using the Bridge library.
Can my users sign in to the API with my service's accounts?
Yes, if your service provides OpenID Connect: we register your service as the provider. SAML is not offered.
Is API access free?
API access is part of the Pro plan. The live pricing page has current plan details.
Related
Tell us which system you run
Start free with one building, no card and no call. Or book a walkthrough and name the systems and devices you want connected; we confirm each one before you commit.