Help · For professionals · Your systems

API keys and webhooks

Connect your organization's own systems. Your organization's data, never a family's records.

Owners can make API keys for reading the organization’s data: the clients list, seats, referral codes, outcomes, members and roles. They can also add webhooks that tell your systems when a family starts or stops working with you, a seat changes, or a referral arrives.

  • A key’s token is shown once. Sovela keeps only a fingerprint of it.
  • A key can do no more than the person who made it, and stops if they lose the permission.
  • Webhooks carry ids only, signed with a secret shown once.
  • A webhook’s address must be https on the standard port (443), on the public internet. Redirects aren’t followed.

The details, with code, are in the developer documentation.

All help · Ask us something