Dispatch in your workflows

Automations#

Dispatch contributes its own triggers into your CRM's workflow engine, and workflows can create dispatch jobs in return. The follow-up text, the review request, the internal alert and the invoice draft all run on the same automation engine as the rest of your CRM, with no connector in the middle.

It also adds job fields to four existing triggers - estimate_accepted, estimate_declined, invoice_paid and invoice_refunded - so a recipe can branch on the job behind a document rather than only on the document itself.

Field	What it holds
event.dispatchJobId	The job the document belongs to
event.dispatchJobNumber	The job number a person would recognise
event.dispatchPropertyId	The property the work is at
event.dispatchServiceType	The service type, or empty when the job has none
event.dispatchJobStatus	The job's status when the trigger fired

The two invoice triggers carry three more, because a payment on a deposit and a payment on a final balance are different events to you:

Field	What it holds
event.dispatchInvoiceRole	deposit, balance, milestone or standard
event.dispatchParentInvoiceId	The invoice this one is part of, when it is part of one
event.dispatchPacketSettled	True on the payment that clears the last part of a multi-part packet

dispatchPacketSettled is the one to filter on for "the job is fully paid, close it out". A rule on balance fires on the first balance part rather than the last, and a rule on the parent invoice never fires at all.

If one of these fields is missing from an event, the job behind that document could not be resolved, and a condition testing it fails closed. A recipe waiting on a deposit does not fire on everything instead.