Skip to content
WorkWing Docs

Integrations overview

An integration is a request WorkWing sends to another service on your behalf. You set up the request once, say what goes into it and what you want back, and then your engineers can run it from a job form while they’re on site.

A broadband installer might run a line test from the job and have the result land in the form. A maintenance firm might look up a customer’s account balance before starting work. Anything with an API you can call over HTTPS will do.

Where integrations live

Section titled “Where integrations live”

Go to Settings > Integrations. The list shows every integration you’ve set up, with its Slug, whether it’s Sync or Async, the HTTP method it uses and whether it’s Active. Click a row to open it.

Integrations belong to your whole organisation, not to one brand: the page carries a Tenant-wide badge, and one integration is available to every brand you run. Which job types use which integration is decided per job type, in the form builder.

The counter next to Create Integration shows how many active integrations you have against your plan’s allowance. Integrations are included on Basic and above. Basic allows 3 active integrations, Standard allows 10, and Professional has no limit. Deactivating an integration frees its place.

To create, edit or delete integrations you need the Tenant Admin role, or a custom role with the integration permissions. Saving an integration that carries a credential, meaning one that references a stored secret, is Tenant Admin only. Running one needs the execute permission on the brand, which is what your engineers need and nothing more.

Building one

Section titled “Building one”

Custom integrations walks through the editor: the URL, the headers, what the request carries and how to pull the pieces you want out of the reply.

Once it’s saved and tested, integration blocks puts a button on a job form so the person doing the work can run it and see the answer. Execution and history is where you check that it’s working and find out what went wrong when it isn’t.

The other ways in and out

Section titled “The other ways in and out”

Integrations are WorkWing calling out. Two other features go the other way, and both are on every plan.

Webhooks tell your systems when something happens in WorkWing, such as a job being created or changing status. API keys let your own software call into WorkWing to read and write jobs, customers and engineers. See Getting started with the API.

You can also connect Claude or ChatGPT to look things up and book work in plain language.

Not sure which you need? Connect WorkWing to another system compares all of them with examples, and the API recipes show complete examples, such as receiving a completed-job webhook and creating and scheduling a job.

What’s next

Section titled “What’s next”