Connect LumaKol to your own software
A REST API to create, find and update leads and to read calls, plus signed webhooks that tell your systems the moment something happens. Each key carries only the permissions you choose.
- Scoped API keys
- Signed webhooks
- Works with Zapier, Make and Pabbly
API dan webhook at a glance
- How leads get in
- Your software calls the REST API with a workspace key sent as a Bearer token, and LumaKol posts signed JSON to your https endpoint for the events you pick.
- How fast
- API calls answer straight away. Webhook deliveries leave a queue checked every ten seconds, so they arrive within seconds.
- Repeats and retries
- X-LumaKol-Delivery stays the same across retries, so you can ignore a repeat. Creating a lead with a phone number or external ID that already exists is refused as a duplicate.
- Where you set it up
- Integrations → API & webhooks, which owners and admins can open. Keys need a paid plan.
How to connect it
- 1
Create a key
Owners and admins open Integrations → API & webhooks, create a key and tick only the permissions it needs. A key can have an expiry date and a list of allowed IP addresses.
- 2
Call the API
Send the key as a Bearer token to api.lumakol.com/api/v1. Every response carries rate-limit headers.
- 3
Add a webhook
Add your https URL, choose the events and press Test. Recent deliveries are listed with your status code or the error.
What you can do
- Create, update, find and delete leads, including by your own external ID
- Add notes and read a lead’s activity
- Read calls, people, pipeline stages and the call outcomes you use
- Get webhooks for lead.created, lead.updated, lead.stage_changed, lead.assigned, call.logged and follow_up.due
- Scopes: leads:read, leads:write, calls:read, users:read and webhooks:manage
- Up to 5 keys and 20 webhooks per workspace; 60 requests a minute per key, 120 a minute and 10,000 a day per workspace
Signing and retries
Each webhook carries an X-LumaKol-Signature header, an HMAC-SHA256 of the timestamp and body, so you can check it came from LumaKol. A failed delivery is tried up to 7 times over about 16 hours, waiting longer each time. Each key acts for the owner or admin who created it and stops working if that person leaves the workspace or loses that role. Revoking a key takes effect at once.
The API is on every paid plan, not during the free trial. Webhooks are on every plan, up to 20 per workspace.
Compare plansCommon API dan webhook problems, and the fix
A new key is refused
The error code says why. An expired key, a request from an address outside the key’s allowed IP list, or a workspace still on its free trial is refused even with the right key. A missing scope answers scope_denied and names the scope the key needs.
Requests start failing with 429
Each key may make 60 requests a minute, and a workspace 120 a minute and 10,000 a day across all its keys, so extra keys add no throughput. Wait for the Retry-After time, and use updated_since to fetch only what changed.
The webhook URL cannot be saved
Webhook URLs must start with https and point at a public address. Private and internal addresses are refused when you save, and checked again before every delivery.
A webhook switched itself off
When the last five deliveries all failed after every retry, LumaKol stops sending and tells the workspace’s owners and admins, with the last error. A redirect or no answer within about ten seconds counts as a failure. Fix the receiver, then switch the webhook back on.
Questions about API dan webhook
Does it work with Zapier, Make or Pabbly?+
Yes. LumaKol’s own Zapier app runs on this API: it uses one of your keys, and its triggers are these webhooks. Pabbly Connect and Make each have a lead source for sending leads in. For anything else, use outgoing webhooks as a trigger and the API through an HTTP action.
What happens if I create a lead whose number already exists?+
The API answers with a conflict (lead_duplicate) instead of making a second lead. The same applies to an external ID that is already used. Look the lead up with GET /leads/find by phone, email or external ID, then update it.
Can I log call outcomes through the API?+
No. Calls and outcomes are read-only through the API; callers log outcomes in the apps. Your software can add notes and update the lead itself.
What if my endpoint is down?+
LumaKol tries each delivery up to 7 times over about 16 hours, with longer gaps between attempts. Every recent attempt is listed next to the webhook with your status code or the error.
Can I use the API during the free trial?+
No. API keys can be created once the workspace is on a paid plan. Outgoing webhooks, which need no key, are on every plan, so you can build and test your receiver during the trial.
Where is the API reference?+
In the LumaKol web app, under Integrations → API & webhooks → API reference. Anyone signed in to LumaKol can open it.
Step-by-step setup guide
Related integrations
All integrationsBeri tim Anda CRM yang menangkap setiap panggilan
Siapkan ruang kerja Anda dan mulai tangkap panggilan di hari yang sama.
- Tanpa kartu
- Hingga 3 admin non-penelepon gratis
- Panggilan dari SIM Anda sendiri