Job State Webhook

Overview

The Job State Webhook is designed to provide real-time updates on the status of a job. It is triggered whenever there is a change in the job's state or when the job is archived. This webhook delivers a payload containing key details about the job's current state, enabling you to seamlessly integrate and respond to changes within your systems. To receive these notifications, configure your callback_url in the settings of your portal.

Job States

This section details the various states a job can be in, providing users with understanding of each state's meaning.

State	Description
in_progress	Job is being actively worked on and under way.
pending_approval	Job is ready for review from the client, and is pending approval.
export_in_progress	Job has been approved by the client, and the export is in progress.
export_failed	A failure occured during the export process.
client_action_required	Job cannot be processed because it requires further action from the client. Progress has been temporarily suspended.
flagged	Completed job has been submitted back to Woflow for rework due to quality error.
cancelled	Customer requested to cancel the job while it was in progress.
failed	An unexpected technical error occurred and the job cannot be completed.
completed	Job has been completed and data deliverables are ready.

Payload Values

Values	Type	Description
state	String	Indicates the state of the job.
status_reasons	String	Provides reasons for job escalation. Applicable only when the job state is client_action_required.
job_id	ID	A unique identifier for the job.
client_mappings	Object	Custom mappings for the client's system.
notes	String	Additional messages explaining the reason for job escalation.
archived	Boolean	Specifies whether the job has been archived.

Example Payloads

in_progress

{
  "state": "in_progress",
  "status_reasons": null,
  "job_id": "779a4057-7e71-4541-a14b-10ec4802ab55",
  "client_mappings": {},
  "notes": null,
  "archived": false
}

pending_approval

{
  "state": "pending_approval",
  "status_reasons": null,
  "job_id": "779a4057-7e71-4541-a14b-10ec4802ab55",
  "client_mappings": {},
  "notes": null,
  "archived": false
}

client_action_required

{
  "state": "client_action_required",
  "status_reasons": "Missing menu source",
  "job_id": "779a4057-7e71-4541-a14b-10ec4802ab55",
  "client_mappings": {},
  "notes": "The url provided does not link to a menu.",
  "archived": false
}

completed

{
  "state": "completed",
  "status_reasons": null,
  "job_id": "779a4057-7e71-4541-a14b-10ec4802ab55",
  "client_mappings": {},
  "notes": null,
  "archived": false
}