Skip to content
Menu
Get started free

Help center / Guides

Integrations and the partner API

An integration lets another system, such as a partner dashboard, receive your check-ins and read your reports. You decide which communities it may see, and you can pause or revoke it at any time. Only the owner opens Integrations.

By Pool Check-in · · 5 minute read

What an integration holds

One integration is one connection. It has an API token, an optional webhook address and the list of communities it may use. The token lets the other system read data. The webhook is how we send it new events.

Creating an integration needs at least one community on a paid plan, Pro or Premium, or a plan arranged with us. On Free the page tells you to upgrade under Plans.

Create one

Open Organization in the menu, then Open integrations, and fill in New integration. Give it a name you will recognize. Add the https address of the other system if you want webhooks, and leave it empty if the system only reads. Tick the events to send: check-ins, vendor visits when they start and end, and submitted reports.

Select Create. The next screen shows the API token and, with a webhook, the signing secret. Each is shown once. Copy them into the other system now. If one is lost, create a new one with the buttons below.

Map the communities

Under Mapped communities, type the other system's own name or id for each community it may see, then select Save. A community left blank stays out. The API and the webhooks serve only the communities you mapped, and every request for another one is refused.

What the other system receives

Webhook events carry ids, counts, times, a vendor visit's company and trade, and the report fields marked safe to share. They never carry resident names. Names and addresses come through the read-only API, for the communities you mapped. Each call is written to an audit log. Treat what comes back as personal data.

The developer guide on the website lists every address, event and field, and has an OpenAPI file for tools that read one. It is for the person who builds the other side.

Pause, rotate and revoke

Each integration shows its status: active, paused or revoked. These buttons change it:

  • Pause stops sending. New events are not queued while it is paused, and the card says how many earlier events are held. Resume sends the held events. Events still held after 7 days are dropped.
  • New token replaces the API token, so the old one stops working. New signing secret replaces the secret that signs webhooks. Each new value is shown once.
  • Revoke ends the integration. Its token stops working at once and the change cannot be undone. Create a new integration to connect again.

What we do not promise

We send each event as soon as we can and try again when the other system does not answer, but how fast it arrives depends on that system. Build the other side to cope with an event that comes late or twice. The developer guide explains how.