Configure a Webhook

A Webhook is a way to notify an outside system that an action has occurred in Trimble Unity using specified information from a request, inspection, work order, work order task, or a case. For example, if an outside financial system is tracking labor information, you can set up a message to be sent every time the labor information on a service request or work order is changed. Webhooks can also be sent to an employee's phone number, in conjunction with a third-party messaging service, to notify them an event has occurred in Trimble Unity. Webhooks do not depend on a work activity having XY coordinates.

PREREQUISITES:

  • GIS services must be configured under GIS > Services. See Configure GIS Services for more information.
  • You must be licensed for webhooks for Webhook to appear in the Action drop-down list. To see if you are licensed for these, look at the license extensions on the Licensing page in the Summary panel.
  • Trimble Unity provides enhanced control over webhook processing through the new WebHookBackgroundWorkerProcess enumeration (enum). This allows you to configure how urgent and delayed webhook messages are handled.
  • A separate service is not needed to retrieve the webhooks from the table and execute them if WebHookBackgroundWorkerProcess.Delayed or WebHookBackgroundWorkerProcess.All is used. See Access Complete List of Webhook Properties for more information on each option for this enum.
  • A separate service is required to retrieve webhooks if WebHookBackgroundWorkerProcess.None or WebHookBackgroundWorkerProcess.Urgent is set.

See Add or Edit an Action Template and Add or Edit an Action Event to configure a webhook.