Introduction to Webhooks

Please note that your subscription plan determines the specific set of features available to you, which may result in differences between what you see and the images presented in this article. For further details on the features included in your plan, please contact your OfficeSpace Admin.
 

If you're looking to trigger events based on certain actions within OfficeSpace, you can do so using webhooks. The Webhooks page in OfficeSpace allows you to create, edit, enable, and disable webhooks dependent on a variety of actions, such as passing a Safeguard attestation or creating a new desk booking.

Accessing Webhooks
Creating a Webhook
Sample Webhook 
Sample Output to Endpoint
Safeguard Webhooks
Desk Booking Webhooks
Moves Webhooks
Request Manager Webhooks
 

Accessing Webhooks

The Webhooks area of OfficeSpace is part of Admin, which can be accessed via the Hamburger menu. 



Note that in order to access Admin, you must be logged in to an account with the correct permissions.

 

Creating a Webhook

To create a new webhook, select New Webhook above the list of webhooks on the Webhooks screen:



You'll be presented with a series of fields that will need to be filled out in order to complete the creation of your webhook. 

Name Field (1)
In this field, input a name for your webhook. 

Event Field (2)
Using this dropdown, select the event from the list that you wish to use as a trigger for the webhook.

Headers Field (3)
In this field, place header information that you would like to pass along with the request, for example, the Content Type.

Http Method Field (4)
In this field, select the HTTP request method for your request. The default method is POST.

URI Field (5)
In the URI Field, enter the URI to which the data should be passed.

Body Field (6)
The body should include any body field variables that you would like to be passed along as part of your request. As different events have different body variables, check out the webhook articles for Moves, Safeguard, Request Manager, and Desk Booking for more information for their respective body variables.  

Insert Merge Field Button (7)
This button contains pre-build fields to use in the body. When chosen, the selected item will be typed into the Body Field.

Enabled Dropdown (8)
If this dropdown is set to Enabled, the webhook will be activated and triggered by the selected event as soon as you have saved it. Set this dropdown to disabled if you would like to save and continue editing the webhook before enabling it.

After your webhook has been created or modified, select Create Webhook (9) at the bottom of the screen to finish creating your entry. 

If you are modifying an existing webhook, the button will be labeled “Save Webhook” instead. 



The webhook will now be in effect and will appear in the list of webhooks on the Manage Webhooks screen.

 

Sample Webhook

 

Sample Output to Endpoint

Below is a sample output based on the above request. As OfficeSpace allows customization of webhook formatting, including customization of formatting and contents, the output of your request may look different. 

A Desk Booking has been CREATED for:
Teegan Torres
Email: ttorres@offficespacesoftware.​com | EmpID: INI_ID_000042 | Dept: Collation
Assigned Site: 11 | Seating Need: Flex
Please review the following information for accuracy:
Start Date / Time: 2021-10-26 13:51:00 UTC | 2021-10-26 13:51:00 UTC
End Date / Time: 2021-10-27 03:30:00 UTC | 1970-01-01 00:00:00 UTC
Desk Label: 90053 | Desk ID:89876 | NH: BadFaxMachine
Floor: Basement | Site: Austin
Booking has been created by: Steven P
Requested Status: approved
Check-in Information:
Check-In Required? false
Check-in Start Time: 2021-10-25 18:03:00 UTC
Check-In End Time: 2021-10-25 17:58:00 UTC
Additional Employee Data:
Staple | S P | Red Team | Flaired | Collation Group

If you have any questions about configuring the output of webhooks, please speak with your OfficeSpace Customer Experience representative.

 

Safeguard Webhooks

To learn more about using webhooks with Safeguard events, including body field variables, please see Webhooks for Safeguard.  

 

Desk Booking Webhooks

To learn more about using webhooks with Desk Booking events, including a list of body field variables, please see Webhooks for Desk Booking.

 

Moves Webhooks

To learn more about using webhooks with Moves events, including a list of body field variables, please see Webhooks for Moves.
 

Request Manager Webhooks

To learn more about using webhooks with Request Manager, including filtering of Request Types, please see Webhooks for Request Manager.