Jobs

A job is a unit of work in Planado. Each job assumes one visit. A typical job could include visiting a client or a site, filling out a report by template, and finishing the job with a resolution.

Resource URL: https://api.planadoapp.com/v2/jobs

Actions

Catalog

Mobile notifications

Job updates issue push notifications to assignees' devices. You can disable these notifications, for example in case of frequent updates, by specifying the header X-Planado-Notify-Assignees: false.

Webhooks

Types of webhooks

Jobs have support for two types of webhooks:

Body format

Webhook body generally shares the format of API responses.

You can see examples of CRUD and status webhooks.

Table 1. Fields
Field	Type	JSON Type	Can be `null`	Description
`event_uuid`	UUID	String	No	Unique event identifier
`event_type`	String	String	No	Type of the event that triggered webhook. E.g. `job_started` or `job_updated`
`context`	Context	Object	No	Event context
`job`	Job	Object	No	Snapshot of the job

Table 2. Fields of `job`
Field	Type	JSON Type	Can be `null`	Description
`uuid`	UUID	String	No	Unique identifier
`external_id`	String	String	Yes	External ID
`external_order_id`	String	String	Yes	Order identifier in an external system. This value is not unique, you can link multiple jobs to a single order, lead or similar thing in another system
`serial_no`	Integer	Number	No	Sequential job number
`status`	String	String	No	Current job status
`scheduled_at`	Datetime	String	Yes	Planned job start time
`scheduled_duration`	Duration	String	Yes	Planned job duration
`description`	String	String	Yes	Large text with job decription. Limited to 15000 characters
`assignee`	Assignee	Object	Yes	Either a user or a team
`type`	Job type	Object	Yes	Job type
`template`	Template	Object	Yes	Job template
`client`	Client	Object	Yes	Client
`site`	Site	Object	Yes	Site
`territory`	Territory	Object	Yes	Territory
`skills`	[Skill]	Array	No	List of skills required for the job
`contacts`	[Contact]	Array	No	List of job contacts
`possible_resolutions`	[Resolution]	Array	No	List of possible resolutions
`custom_fields`	[Custom field]	Array	No	List of custom fields
`report_fields`	[Custom field]	Array	No	List of report fields
`resolution`	Resolution	Object	No	Job resolution. The field is present only for finished jobs
`version`	Integer	Number	No	Version
`created_at`	Timestamp	String	No	Timestamp of creation
`updated_at`	Timestamp	String	No	Timestamp of last update
`previous`	Job	Object	No	Snapshot of the previous version. This key is only present for `job_updated` events