API keys and webhooks

Integrations › API keys and Webhooks. For connecting your own systems, such as another billing or accounting tool, or a script a developer has written.

An API key lets other software work with your books: create invoices, fetch reports and record bank transactions.

1. Select Generate API Key and give it a Key label you will recognise (for example Billing portal).
2. Copy the key straight away. It is shown only once. VexLedger cannot show it again.
3. Give it to your developer or paste it into the other system.

To stop a key working, select Revoke against it. Revoked keys are marked as such and cannot be used again.

A webhook lets VexLedger tell another system when something happens, such as an invoice being issued or paid, or a bank row being matched.

1. Select Register Webhook and enter the HTTPS address of your system.
2. Choose the events you want. By default these are invoice created, invoice issued, invoice paid, bank transaction matched and payment received.
3. VexLedger gives you a signing key. Your system uses it to check that each message really came from VexLedger.

Each webhook has a Deliveries log showing recent delivery attempts, so you can see whether your system received them.