Developer overview

There is no single Softlinks API, and a unified one would be a fiction — each product is its own deployment with its own data model and its own release cycle. What they share are conventions: REST over JSON, authentication scoped to a tenant rather than to the platform, and IDs that are stable across versions. The authoritative specification for each one lives in that product’s admin console, because that is the copy that ships with the running code.

Tenant scoping is the part worth understanding before you start. A credential belongs to one organization inside one product, so integrating across two products means two credentials and two scopes. This is deliberate — it means a partner integration for one school or one clinic cannot read another’s records, even by accident.

Webhooks are enabled per product and per event type rather than globally, and the set differs by product because the events differ: enquiries and appointments in one, job state changes in another, delivery and bounce events in mail. Ask for what you need and we will tell you whether it exists today.

For technical evaluation, a sandbox tenant is better than reading specifications. It comes with demo data, is isolated from production, and can be wiped without consequence. Request one with the product and the integration you have in mind.