Lesson 4 of 7 · 8 min

Webhooks and the API (Franchise plan)

Connect outside systems with webhooks and the API on the Franchise plan.

Read the lesson

Goal: Decide when a client truly needs the API or webhooks. Price the move to Franchise. Set up keys safely.

You need: Lesson 3 of this course. Franchise for API keys, outbound webhooks and the Webhook Trigger.

Why this matters

Some clients run other software that must talk to ServiceAgent. An accounting system may need new jobs. A supplier portal may need won deals. A website form may need to start a workflow. Most of these links work through ready-made integrations, Zapier or Make.com. A few need the API or webhooks. Those are Franchise features. Promise an API link to a Growth client, and you face a choice. You break the promise, or you add $184 to $230 a month to the bill. This lesson helps you choose the cheapest path that truly works, and price it honestly.

What each piece does

The API lets another system ask ServiceAgent for data or send data in. The other system starts the call. You create a key for it in Settings → Connections & developer tools → API keys.

Outbound webhooks let ServiceAgent tell another system that something happened. ServiceAgent starts the call. You set them up in Settings → Connections & developer tools → Webhooks.

The Webhook Trigger lets another system start a ServiceAgent workflow. For example, an outside form posts to the workflow and the workflow texts the lead.

All three are Franchise features. A Growth account may still show Webhook Trigger in the Trigger Type list. Do not build on it for a client below Franchise. Send outside forms in through Zapier or Make.com instead. Or move the form to the ServiceAgent booking page or chat widget.

Fig 1

Three Franchise pieces and who starts the call

PieceWho starts the callWhere you set it up
APIThe other systemAPI keys
Outbound webhooksServiceAgentWebhooks
Webhook TriggerThe other systemTrigger Type in a workflow
All three are Franchise features. A Growth account may still list Webhook Trigger. Do not build on it.

The decision path

Go down this list and stop at the first option that works.

  1. Use a ServiceAgent feature instead. The booking page and chat widget replace many outside forms.
  2. Use a ready-made integration. Check Integrations for Zoho CRM, HubSpot, Pipedrive, Calendly, Acuity Scheduling and the beta field service links.
  3. Use Zapier or Make.com. These connect thousands of apps without code.
  4. Use the HTTP Request step to send data out from a workflow.
  5. Move to Franchise for API keys, outbound webhooks and the Webhook Trigger.

Each step down costs more to build, more to run or more to maintain. Write down why each earlier option did not fit. The owner will ask, and so will the next Operator.

Fig 2

The decision path for an outside link

  1. A client system must talk to ServiceAgent
  2. Can a ServiceAgent feature replace it?YesUse the booking page or chat widgetEnds hereNoGo to the next question
  3. Is there a ready-made link in Integrations?YesConnect it thereEnds hereNoGo to the next question
  4. Do Zapier or Make.com connect it?YesBuild the link thereEnds hereNoGo to the next question
  5. Does data only go out from a workflow?YesUse an HTTP Request stepEnds hereNoMove to Franchise
  6. Franchise: API keys, outbound webhooks, Webhook TriggerGet the owner's written yes first
Stop at the first option that works. Each step down costs more to build or run.

Pricing the move to Franchise

Show the owner the difference in their own billing type. Month to month, Growth is $119 and Franchise is $349. The gap is $230 a month. Billed yearly, Growth is $95 a month and Franchise is $279. The gap is $184 a month.

Fig 3ServiceAgent pricing

Growth vs Franchise price

Month to month
  • Growth $119
  • Franchise $349
  • Difference $230 a month
Billed yearly
  • Growth $95 a month
  • Franchise $279 a month
  • Difference $184 a month
Quote the difference in the client's own billing type.

Franchise also includes 3 locations, 20,000 credits a month, a 5% ad fee and priority support. For a client with 3 locations, Franchise can cost less than Growth. Growth with 3 locations costs $119 + $119 + $119 = $357 a month, month to month. Franchise costs $349 month to month with 3 locations included. That is $8 a month less. So check the location count before you call Franchise "expensive." Also check credits. Growth includes 6,000 credits a month. Franchise includes 20,000. A busy client who buys several credit packs each month on Growth may already spend part of the gap. Add the packs to the Growth side of your table before you compare. Show the owner the full numbers side by side, so they can decide themselves. Put the comparison in writing and keep it in your client folder. Revisit it each year, or when the client adds a location. Prices change, so check the current plan page first.

Fig 4ServiceAgent pricing

3 locations, month to month

Growth: $119 × 3 locations$357
−Franchise, 3 locations included$349
Franchise saves$8 a month
With 3 locations, Franchise can cost less than Growth.

By business size

An owner-operator almost never needs the API. Zapier or a spreadsheet export covers most needs. A fleet of 8 to 20 techs sometimes needs it, usually for accounting or a parts supplier. Even then, Zapier or Make.com often does the job for a small monthly fee. A multi-location client is the most likely Franchise fit. The 3 included locations may already justify the plan. Add API access, and the case is often clear.

Who maintains the link

Every outside link needs an owner after go-live. Write down who fixes it when it breaks: you, the client's IT person, or the other vendor. Put that name in your Operator notes and in the scope of work. A link with no owner breaks quietly. The client finds out when the books do not match. Check each link once a month as part of the data checks in Prove lesson 2. If you charge for upkeep, put it in the scope. If you do not, say so in writing.

Keep keys safe

An API key is like a master key to the client's data. Treat it that way.

  • Create one key per connected system. Name it after the system.
  • Never send a key by email or text. Paste it straight into the other system.
  • Store keys only where the other system keeps them. Do not keep a copy in your notes.
  • When a system is retired, or a vendor leaves, delete its key the same day.
  • Check Audit logs after setup to see the key's activity.

The client's data belongs to the client. Get the owner's written yes before you connect any outside system.

Build it in ServiceAgent

  1. Write down the need in one sentence: "The accounting system must receive each new job."
  2. Walk the decision path. Note why each earlier option did not fit.
  3. If Franchise is needed, show the owner the price table. Get a written yes.
  4. Change the plan in Plan & Billing → Current plan. Upgrades apply now.
  5. Open Settings → Connections & developer tools → API keys. Create one key, named for the system.
  6. Give the key to the other system's admin, inside that system's settings screen.
  7. For outbound events, open Webhooks. Add the address the other system gives you.
  8. Run one test event. Check that the other system received it.
  9. Check Audit logs for the key's first use.
  10. Check it works: a week later, compare 10 jobs in ServiceAgent with the other system.
Fig 5

Where keys and webhooks live

Developer Settings (Franchise)

API KeysOne key per connected system
WebhooksThe address the other system gives you
OAuth AppsApps that sign in to the account
MCPAI tool connections
Audit LogsEach key's activity
Generate New Key
Create one key per system and name it for that system. Check Audit Logs after the first use.

The exact API fields and event names are in ServiceAgent's developer settings. Check them there, not in this lesson.

Worked example: Volt Pro Electric

Volt Pro Electric has 10 electricians on Growth. It pays month to month. The owner wants each new job to appear in their accounting system.

You walk the path. The booking page does not help, because the data must leave ServiceAgent. Their accounting system has no ready-made integration. You check Zapier. It has a connector for their accounting system. You build the link in Zapier. The cost is the Zapier plan the owner already pays for, plus no plan change.

Without the decision path, you might have moved Volt Pro to Franchise. That would add $349 − $119 = $230 a month, or $2,760 a year, for a link Zapier already does.

Fig 6ServiceAgent pricing

Volt Pro with and without the decision path

Straight to Franchise
  • Move from Growth to Franchise
  • $349 − $119 = $230 more a month
  • $2,760 more a year
  • For one link
Walk the path first
  • Booking page: no help
  • No ready-made integration
  • Zapier has a connector
  • No plan change
Zapier already did the job. The path saved Volt Pro $2,760 a year.

A year later, Volt Pro opens 2 more locations. Now Franchise is worth a look. Growth with 3 locations is $357 a month. Franchise is $349 and adds API access. Now the move saves $8 a month.

Common mistakes

  • Mistake: Building on Webhook Trigger for a Growth client. Fix: It is a Franchise feature. Use Zapier, Make.com or the booking page.
  • Mistake: Moving to Franchise before trying Zapier. Fix: Walk the decision path first.
  • Mistake: Quoting only the monthly price to a yearly client. Fix: Quote the difference in the client's billing type.
  • Mistake: One shared key for every system. Fix: One key per system, named for it.
  • Mistake: Sending keys by email. Fix: Paste them straight into the other system.

Do this now

Pick one outside system a client might want to connect. Walk the 5-step decision path in writing. Stop at the first option that works. If it ends at Franchise, write the price difference for both billing types. Deliverable: a half-page decision note. Time: 20 minutes.

Practice the conversation

  1. Owner Can ServiceAgent send jobs to my accounting software?
  2. Operator Yes. First I check the cheapest way to do it.
  3. Owner What are the options?
  4. Operator A ready-made link, Zapier, or the API. The API needs the Franchise plan.
  5. Owner How much more is Franchise?
  6. Operator For you, $230 a month more on monthly billing.
  7. Owner That is a lot for one link.
  8. Operator Agreed. Zapier already connects to your software, so we use that.
  9. Owner And if I open more locations?
  10. Operator At 3 locations, Franchise costs less than Growth. We will look again then.

Quick check

  1. A roofing client on Growth pays month to month. Its accounting system must pull jobs through the ServiceAgent API. No ready-made link or Zapier connector fits. How much more a month would Franchise cost?
    • $230
    • $184
    • $279
    • $349
  2. A Growth client wants an outside website form to start a workflow. What do you do?
    • Use the `Webhook Trigger`, because it shows in the list.
    • Send the form in through Zapier or Make.com, or move it to the booking page.
    • Create an API key on Growth.
    • Tell the owner it cannot be done.
  3. A vendor that used an API key stops working with the client. What do you do with its key?
    • Keep it in case the vendor returns.
    • Share it with the next vendor.
    • Delete it the same day.
    • Change its name.

ServiceAgent UniversityLearn to run a service business on autopilot. Free courses, Blueprints and certification for Service Operators.

Learn

Get certified

Community