Purpose
The "API and webhooks" tab allows administrators to grant third party tools read access to organisational data through the REST API, and to receive signed notifications when specific data changes.
Available resources include properties, units, leases, owners, listings and transactions, while webhooks cover lease creation and modification, payment receipt and the arrival of a new enquiry.
Where to find it
- Investment
- Reports
The "API and webhooks" tab is restricted to administrators.
Steps
- Enter a "Key name" in the "API keys" card and click on "Create key".
- Copy the key immediately using "Copy", because it will no longer be displayed, and then transmit it in the Authorization header of your calls.
- In the "Webhooks" card, enter the "HTTPS address", tick the desired "Events" and click on "Add webhook".
- Copy the displayed signing secret, which enables your server to verify the origin of each delivery.
- Click on "Send test" to check reception, and then consult "Recent deliveries".
Good to know
- The API is limited to 120 requests per minute per key, and the documentation in the tab describes pagination and filtering by modification date.
- A response other than 2xx triggers up to three redeliveries of the webhook.
- "Revoke" immediately cuts off access for applications using a key, and "Suspend" interrupts a webhook without deleting it.