Zapier Integration
Connect Cooledge to thousands of apps with the planned Cooledge Zapier app. Covers the API-key Custom Auth connection, the eight REST Hook triggers and the seven write actions, how they map onto the v1 API and webhook events and how to join the private early-access release.
Zapier Integration
Zapier lets non-developers wire Cooledge to thousands of other apps without writing code. With the Cooledge Zapier app you will be able to start a Zap from a Cooledge event such as a new customer, a sent quote or a paid invoice, then have it act in another tool. You will also be able to push records the other way, creating a customer, a lead or a booking in Cooledge from a form, a spreadsheet or any other Zapier trigger.
Planned and invite-only. The Cooledge Zapier app is not generally available yet. It is rolling out during early access as a private, invite-only release. Everything below describes what the app will do when you are in the release. To join the private Zapier release, contact Cooledge and ask to be added. This guide does not mean the app is live in the public Zapier directory today.
Available on the Growth and Scale plans. The Zapier app uses the same API key as the rest of Cooledge's API and integrations access, which Starter plans do not include. Upgrade to Growth or Scale to use it once you are in the release.
The Zapier app is a friendly front end over the same API documented in the rest of these guides. Its triggers are the Cooledge webhook events and its actions are the v1 REST endpoints. So anything you can do in Zapier you can also do directly against the API, and anything you learn about the API carries straight over to Zapier.
Connecting your account
The Cooledge Zapier app authenticates with Custom Auth using your Cooledge API key. It is the same X-Api-Key key you use everywhere else in the API, sent on the same header.
When you add a Cooledge connection in Zapier you paste your API key once. Zapier stores it and sends it on every request the app makes on your behalf. To confirm the key is valid, connecting calls GET /v1/me. If the key is good, that call returns your business and the connection is established. If it is missing, malformed or revoked, the call fails and Zapier tells you the connection could not be made.
You request an API key from Cooledge the same way you do for direct API use. During early access there is no self-serve key page in the product. See Getting Started and Authentication for how keys are issued and how to read a 401 or 403. Treat the key like a password: it is a full credential, so do not share the connection or the key in plain text.
Triggers
Triggers start a Zap when something happens in Cooledge. The Cooledge app uses REST Hooks rather than polling. With REST Hooks, Zapier subscribes once to the event you picked, then Cooledge POSTs to Zapier the moment that event fires. There is no polling on a timer, so your Zap runs as soon as the event happens and Zapier does not burn task checks asking "is there anything new yet?"
Each trigger maps to one Cooledge webhook event. The payload you receive in Zapier is the same event payload documented on the events index.
| Trigger | Webhook event | Fires when |
|---|---|---|
new_customer | customer.created | A new customer is created in Cooledge |
new_lead | lead.created | A new lead is captured |
quote_sent | quote.sent | A quote is sent to a customer |
quote_accepted | quote.accepted | A customer accepts a quote |
won_lead | lead.won | A lead is won, with a quote accepted or paid or a first invoice paid |
job_completed | job.completed | A job is marked complete |
invoice_paid | invoice.paid | An invoice is paid in full |
booking_created | booking.created | A booking or scheduled visit is created |
Because these are the same events covered in Webhooks, the same rules apply to what your Zap receives. Payloads are additive, so ignore keys you do not recognise rather than failing on them, and the same event can arrive more than once, so design steps that should run once to tolerate a repeat.
Actions
Actions are the write side. A Zap can trigger on anything: a new row in a sheet, a form submission or a calendar event. It can then finish by doing something in Cooledge. Each action maps to one v1 endpoint, documented in the API reference.
| Action | What it does | v1 endpoint |
|---|---|---|
create_customer | Create a customer | POST /v1/customers |
find_customer | Search for or list customers | GET /v1/customers |
create_lead | Create a lead | POST /v1/leads |
create_booking | Create a booking or scheduled visit | POST /v1/bookings |
create_invoice_line | Add a line to an invoice | POST /v1/invoices/{id}/lines |
send_invoice | Send an invoice to the customer | POST /v1/invoices/{id}/send |
create_quote_ducted | Create a ducted-system quote from a high-level area, with capacity, outlets and zones rather than raw engine data | POST /v1/quotes/ducted |
find_customer is a search action, so it is the one you reach for when a later step needs an existing customer id. A common pattern is to search with find_customer, then create the customer only if the search comes back empty, then carry the id forward into create_booking or create_invoice_line.
Each action needs the matching scope on your API key. Creating a customer needs
customers:write, finding one needscustomers:read, and so on for leads, bookings, invoices and quotes. If a Zap step fails with a permission error, the key is missing the scope that action requires. The scope list is in Authentication, and the scopes your key holds are returned byGET /v1/me.
How it relates to the API
The Zapier app does not add a second API. It is a thin layer over the surface these guides already describe:
- Triggers are webhook events. A Cooledge trigger is a REST Hook subscription to one of the events on the events index. The payload is the same one Webhooks documents. Whether an event reaches Zapier or your own endpoint, it is the same event.
- Actions are v1 endpoints. Each action calls the matching endpoint in the API reference with the same request body, the same validation and the same response.
So the API reference is also your reference for Zapier. If you want to know which fields an action accepts or what a trigger payload contains, read the endpoint or the event page. And if you outgrow what a Zap can express, you can move that step to a direct API call without changing the underlying behaviour.
Getting access
The Cooledge Zapier app is a private, invite-only release during early access. It is not in the public Zapier app directory yet, so you cannot find and add it by searching Zapier on your own.
To join:
- Contact Cooledge and ask to be added to the private Zapier release. Mention that you are on Growth, Scale or a free trial so we can confirm your access.
- Get your API key. If you do not already have one, request an API key for your business at the same time. See Getting Started.
- Accept the private app invite. We send you an invite link to the Cooledge Zapier app. Open it, add a Cooledge connection and paste your API key. The connection validates against
GET /v1/meand you are ready to build Zaps.
As the release widens, the app will move toward general availability in the public Zapier directory. Until then, the private invite is the way in.
Where to go next
- Getting Started covers requesting a key and making your first call.
- Authentication covers the key format, the scope list and how to read auth errors.
- The events index and Webhooks cover the events behind every trigger.
- The API reference is the endpoint-by-endpoint spec behind every action.
Need a hand with an integration? Contact support