Technical documentation: all current API routes, permissions and examples are available at docs.fitsociety.io. Developers should start with the Public API quickstart.
A webhook sends a notification to another system when something happens in FITsociety. Your CRM could respond to a new member, or your automation could start after a new booking.
In this article
What do you need?
You need access to the Public API and webhook management for your company, plus a receiving URL from your developer or automation tool. It must be a publicly reachable HTTPS URL. A localhost or internal network address does not work.
A webhook reports an event; the other system performs the next step. Retrieving additional data or making a change in FITsociety may also require an API client with suitable permissions.
Create the webhook
In the correct company, go to Settings → Plugins and Integrations → Webhooks.
Choose Add webhook and enter a recognizable name.
Enter the receiving URL in Target URL.
Review Events and select only the events you need, such as
client.createdorbooking.created. Check the preselection too.Save the webhook and copy the signing secret shown once. Ask your developer to store it securely and verify notification signatures.
Test and check deliveries
Use the test action on the webhook and check whether the receiving system processes the notification. Also review recent delivery attempts in FITsociety. A successful delivery has status delivered: the receiver returned HTTP 2xx.
If an error occurs, there are at most three delivery attempts in total. A failed delivery may still be retried; exhausted means no attempts remain. When delivery fails, have the receiving URL, availability and error message checked.
A successful test confirms that receipt works. Also check one real event and the intended follow-up action before relying on the workflow.
Update and process notifications carefully
Edit the webhook to change its URL, events or status. Set the webhook to Disabled to stop new notifications through this webhook. Check actions already received or in progress in the other system too.
Notifications contain compact data, not a complete client record. The receiver should recognize duplicate notifications using the stable event ID so the same event does not trigger an action twice.
For management through the API, webhooks:read, webhooks:write and, for delivery attempts, webhook_deliveries:read are available. The technical documentation covers events, payloads and signature verification.
Related articles
Technical documentation for your developer (English)