Work Order Complete Webhook

Introduction

As FSI continues to build out our API strategy, we've incorporated webhooks to allow for more
efficient, responsive, and scalable ways to connect and communicate with your systems and
services.

In November 2023 we introduced the ability to “subscribe” to the webhook for Work
Order Complete. There are multiple downstream processes that are often “triggered” when a
Work Order is completed, including potentially creating corrective Work Orders, sending email
or mobile notifications, and/or updating integrated external systems. The feature provides the
ability to capture when a Work Order is completed and forward that completed Work Order to
your systems.

As our customers may integrate with many 3rd Party systems, multiple subscriptions can be
created on a segment (allowing you to connect multiple systems to the Completed Work Order
event).

For this release, the completed Work Order is the payload that will get processed with this
event.

Webhooks Value for FSI Customers:

Webhooks facilitate event-driven communication, allowing you to tap into the various events
that occur within CMS without the need to continuously poll for changes.

Webhooks enable seamless integration with third-party APIs by sending them real-time updates
when relevant events take place.

Webhooks can notify your external systems instantly when these events happen, ensuring
timely information updates.

Over time, more Webhooks will be introduced to support ways to connect and communicate
with your systems and services.

How to Setup Webhooks to Get Alerted When Work Orders
are Completed

Step 1: Log into CMS and Open Admin Console

Step 2: Navigate to User Management Settings. Within User Management Settings open the
Menu Role Configuration

Step 3: From the Menu Role Configuration, select the role that's appropriate or assigned,
ensure that the new Service Hooks item is selected in the Facility Settings section. Be sure to hit
Save.

Step 4: Now, still in the Admin Console, access the Facility Settings. You will now see a menu
item called Service Hooks. Click to open it.

Step 5: Create a New Subscription: Once in the Service Hooks section, locate the "+
Subscription" option in the top right corner and click on it.

Step 6: Configure Subscription Information: On the "Add Subscription" screen, enter the
required information into the provided fields. This includes details like Description, Target URL,
and the Event (e.g., Work Order Complete). All the red fields are required. Note that more
Events will be added over time. After entering the subscription information, click "Save" to
create the new subscription.

• Description: A description of what this service hook is for.
  • Target URL: The endpoint on the third-party system which will consume the work order completed event payload. This could be your facilities own REST API or a third-party service you use that can consume the request data.
• Trigger Event Type: The event this Service Hook subscription will trigger from, currently, only the Work Order Completion scenario is supported. With this event, the specified Target URL, will receive the work order that was completed in the request payload.
• Status: The Status of the Service Hook, this can be set to Active/Inactive, and when the Triggering Event occurs will control whether a request is made to the specified Target URL. This can be thought of as the on-off switch for the service hook.
• Token: The token field provides the user the option to set an authentication token if the system being connected to requires one. The token field contains two inputs (Token Prefix & Token Content).
• Token Prefix: Depending on the auth-scheme being used this will either be ‘Basic’ or’ Bearer’.
• Token Content: The actual value of the token

The system will combine these two values and generate the appropriate ‘Authorization’ header for the request.

• HTTP-Headers: Certain requests may require additional headers to be specified. The headers text-area accepts key-value pairs of headers that will be appended to the request when sent. Headers should be added as key-value pairs, with each pair appearing on its own line.

Step 7: View and Manage Your Subscription: You should now see your newly created
subscription listed in the Service Hooks section. Use the three little dots (or ellipses) on far right
next to your subscription to Edit, Delete, or Review the History of the requests/triggers that
occur.

Reviewed/Revised: 9/2024
Copyright © FSI 2023