The AccuLynx API, Read Line by Line: Keys, Jobs, Webhooks and the Gaps

Public docs, private keys: who gets in and how

Start with the good news. The AccuLynx API documentation needs no login, and the current version is V2. The old V1 documentation has been taken down; AccuLynx says V1 endpoints still answer but recommends moving to V2, where a new lead is made with the Create Job endpoint. Its Getting Started page lists three requirements: an active AccuLynx account, an API key, and a technical grasp of how APIs work. That third item is the docs' polite way of saying this is a job for a developer.

AccuLynx offers two routes in. Zapier is meant for people with little integration experience. The Advanced API is for experienced developers and reaches every endpoint. The examples AccuLynx gives are the two that matter most to a roofer: adding leads from another application, and sending a job's contacts to marketing software when the job reaches a milestone.

• The add-on. In AccuLynx's words: "Yes, you must enable the AppConnections add-on to access select third-party app connections as well as AccuLynx API keys." It is switched on from the Add-Ons section of the AccuLynx Market. No price is published, and AccuLynx does not say which plans can add it.
• The person. "Keys can be created by your Location or Company Administrator within AccuLynx Account Settings." A developer cannot make one from outside.
• The location. "Accounts with multiple locations will need to connect each location to our API individually." A three-branch company sets up three connections.
• The help desk. AccuLynx Customer Support "provides troubleshooting and guidance for the AccuLynx web and mobile applications only." API questions go to api@acculynx.com, and the docs recommend "working with qualified developers or technical integration partners."

One header, no OAuth, and a key that behaves like a master password

Authentication is plain. Every request carries Authorization: Bearer <API key>, and there is no OAuth flow to set up. Data calls go to https://api.acculynx.com/api/v2/, webhook management to https://api.acculynx.com/webhooks/v2/. Simple to code. Also simple to misuse, which is why AccuLynx's own developer guide warns that anyone holding a key can expose or change company data, and tells customers to treat keys like passwords.

That rule settles where the code runs. A key typed into a form plugin's settings screen, pasted into a script tag or emailed around the office is a key with too many owners. On the sites we build, it lives in the server's environment, the browser never sees it, and the form talks to our server rather than to AccuLynx directly. The contractor enables the add-on and creates the key in their own account. We never ask for anyone's AccuLynx login, and a vendor who does has told you something useful about the rest of the job.

Can the API do this? Twelve questions, answered from the reference

The V2 reference groups its endpoints as acculynxCommon, calendar, company, contacts, diagnostics, estimates, jobs, leads, users, reports, invoices, financials and supplements, with a separate Webhooks API. The table answers the questions roofers and their developers actually ask, using endpoint names exactly as AccuLynx publishes them, as of October 2026.

Two reads deserve a mention because sync jobs live on them. Get Jobs filters by startDate and endDate with dateFilterType set to CreatedDate, MilestoneDate or ModifiedDate, and by milestone and assignment; pageSize defaults to 10 and tops out at 25. The jobs group also reads financials, payments, representatives, milestone history and insurance details, which is what a custom dashboard is built from. Report rows themselves never come through the API.

From web form to Lead milestone, in AccuLynx's own order

AccuLynx wrote a guide called Create a Lead/Job from a Third-Party System, and a careful website follows it to the letter. The sequence is the whole craft of a lead form integration, so it is worth seeing in order:

1. 1.Search for the contact, and create one only when nothing matches.
2. 2.Get the contact type ID. Leave the type blank and AccuLynx defaults to Customer.
3. 3.Look up the IDs for job category, work type, trade type and lead source from AccuLynx's own lists.
4. 4.Create the job. It lands in the Lead milestone with no assigned rep, optionally with a location address and a priority of Urgent, High or Normal.
5. 5.Add the extras afterward: the initial appointment, insurance details, job messages, documents, photos, a sales rep through Update Company Representative, and custom fields.

The small print matters. Phone numbers must be 10 digits, typed Home, Mobile or Work. Create Contact marks no top-level field as required, so the website has to enforce its own minimum; nothing in the schema stops a contact with no name. Notes longer than 1,000 characters belong in Create Job Message. And the guide tells integrators to store the AccuLynx contact ID, job ID, external lead ID, lead source ID and sync timestamps, which is exactly what makes a retry safe: a server that remembers what it already sent never sends it twice.

Webhooks, polling and two rate limits that disagree

AccuLynx has webhooks, and they are the right way to learn that a lead became a contract. A subscription needs a consumerUrl (a public HTTPS address that accepts POST and cannot be changed later), a techContact email and topicNames. Published topics include Job Created, Job Updated, Job Appointments Initial Created and Updated, Job Milestone Current Changed, Contact Added and a set of custom-field events. The Job Created payload carries the job's milestone, contacts, address, lead source, category and work type. A test-event endpoint sends a sample that is not stored.

The webhook guidelines are short and firm: "The timeout limit for webhooks is 10 seconds." Respond with a 2xx code. "Be prepared to handle duplicate events." And "If the listener responds with errors too many times, the webhook subscription will be disabled." Registration returns a secret "for validation," but the docs do not describe how a signature is checked, so we do not invent a method. Our listeners answer at once, put the event on a queue, and use its eventId to ignore repeats.

Polling still has a place. A nightly pass over Get Jobs, filtered by ModifiedDate, catches anything a webhook missed while a server was restarting. One more absence to plan around: AccuLynx documents no sandbox. Testing happens in a live location, so we agree a naming convention for test records with the office before the first one is created, and nobody calls a homeowner named Test Testerson.

Getting a key and scoping the project, in eight steps

This is the order we follow with a roofing office, and it works as well for a company hiring someone else. Menu paths below come from AccuLynx's own articles and can differ by account.

1. 1

   Confirm AppConnections with AccuLynx

   Ask your AccuLynx contact whether the add-on is on your account and what it costs on your plan. AccuLynx publishes neither the price nor which plans qualify.

2. 2

   Choose the administrator who will hold the keys

   Only a Location or Company Administrator can create one. AccuLynx's Zapier article gives the path as Account Settings, then Add-On Features and Integrations, then API Keys, then Create Key.

3. 3

   Count your locations

   Each location connects separately, so a multi-branch company decides which branches the website feeds and creates a key for each.

4. 4

   Tidy the lead sources first

   Every source the website will use, such as a Google Ads campaign, a storm landing page or a yard sign number, must exist and be active in AccuLynx, since the API cannot add one.

5. 5

   Write the field map

   List each form field and where it goes: contact, job, custom field or job message. Decide where the Google click ID lives. Agree the job category, work type and trade type for each form.

6. 6

   Decide what flows back

   Pick the webhook topics the site or dashboard needs, such as Job Created and milestone changes, and what a nightly polling pass should catch.

7. 7

   Agree how testing works

   With no sandbox, test records go into a live location under a name the office recognizes, and the office knows when testing happens.

8. 8

   Install the key on the server

   The administrator creates the key and passes it through a secure channel straight into the server's settings. It never goes into the browser or a plugin settings page.

How we build on it, and the price of a connection

Our API integrations work follows the same habits on every project, and AccuLynx's documentation rewards each of them. We are a San Antonio studio, not an AccuLynx partner, and nothing here is endorsed by AccuLynx.

The closest proof is outside AccuLynx. HomeService WebApp, a contractor command center we redesigned, puts open estimates, customers and overdue follow-ups in one place, the same shape as an AccuLynx dashboard built from jobs and milestones. LeadBolt, our speed-to-lead product, shows the fast-response side. Both are in our work; neither is an AccuLynx integration.

A connection on your current site is priced in writing after a free review, and joining two systems tends to take one to three weeks. If the site needs replacing, see web design pricing and 0% website financing; a free site audit is the easy first step. For the website's side of each handoff, read online inspection booking, text messaging, lead source tracking, plugins versus a custom build, and how AccuLynx compares with JobNimbus and Roofr. The AccuLynx integration hub maps the rest, and roofing website design covers the site itself.