vWork for developers

Which version should I use?

Version 5 is our current version

Version 5 of the API is our current version and should be used when creating a new integration.

There are three sets of documentation for v5. The base documentation covers everything except jobs (eg: users, customers).

The Jobs documentation covers creating and managing jobs from scratch.

The Templated Jobs documentation covers creating jobs from templates. This is the best option if you need to create jobs in vWork and requires the least coding.

I'm ready to go

Getting your API key

If you already have a vWork account, you can create your own API Key here on the integrations page.

If you don't have account user access, please contact your administrator. If you do not have a vWork account as yet and want to learn more, please get in touch with us.

Having trouble?

We’re here to help

Contact our integrations team if you'd like to talk through your project.

Or alternatively you can create a new support ticket through our job logging system and we will follow-up with you as soon as we can. Or you can use the Live Chat icon in the top right corner of vWork portal. And if we are not online, this will create a support ticket for us to get back to you ASAP.

Jobs

A job is a task assigned to a mobile worker with details, workflow and custom fields.

Templated Jobs

Create job types once and reuse them, making repeat jobs fast and easy to set up.

Tech Notes

The answers to all kinds of technical questions - and where to find them quickly.

Customers

Customers are who you complete jobs for, with contact and billing info captured.

Users

Lets you manage all vWork users, including mobile workers, dispatchers and admins.

Proof of Delivery

Proof of Delivery combines signature, photo, name and time from completed jobs.

Pick Lists

A custom field within a Job with a set of pre-defined items a user can choose from.

Groups

Allows you to separate your workers into different teams e.g. sales and service.

Attachments

A file that belongs to an image custom field for a job - it is always of type JPEG.

Messages

Sent from worker to dispatcher and vice versa; add, edit or delete messages via API.

Signatures

As well as for PoD - a signature can be a custom field for a job, sent as a PNG.

Webhooks

vWork can send webhook callbacks to a specified endpoint URL when a change is made.

Get even more out of your business tools using our API