API & Webhooks

The REST API #

Settings > API gives other systems credentials to use LBM through its REST API: look up clients, create invoices and more, with an API key and the permissions you give it.

• Create a key per system, so you can revoke one without touching the others.
• Give each key only the permissions it needs.
• Keep keys secret: anyone with a key can do what it allows.

An interactive reference of the endpoints is part of the API documentation page of your install.

Webhooks #

Settings > Webhooks tells other systems when things happen, such as an invoice being paid, a service being suspended or a ticket being opened.

1. Add a webhook with the address to call and the events to send.
2. LBM sends a signed request to that address when one of the events happens, so the receiver can check it came from you.
3. A webhook that fails is retried, and failures are recorded.

Gateway webhooks are different #

The webhooks in Settings > Payment gateways are the other direction: a payment provider calling LBM to say a payment happened. They are set up for you when you save a gateway's keys (Stripe, PayPal), and the address to give a provider is shown on the gateway's screen.