Configure a Webhook

A Webhook is a way to notify an outside system that an action has occurred in Cityworks 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 Cityworks. 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.

NOTE: Webhooks send messages out to a queue where they wait to be transferred to the desired location. Webhooks do not send out the messages directly. The Message Queue Service Installer is required to complete the transfer of data, or you can create your own application and use the MessageQueueAPIs.

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