Webhooks for Request Manager

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 tie a particular action to activities involving Request Manager, you can do so using webhooks. These are customized messages sent from your organization's instance of OfficeSpace each time a specific Request Manager event has been triggered. Webhooks can be configured via the Webhooks panel in Admin, which you can access using the Hamburger menu.

You will only be able to access Admin if your account has the privileges set to do so.



For more information on using webhooks, see Introduction to Webhooks.

Available Request Manager Webhooks
Available Body Field Variables
Sample Webhook
Sample Output to Endpoint
Filtering by Request Type

 

Available Request Manager Webhooks

The following desk booking events have a webhook available for you to use:
 

Event	Result
Opened	The action will trigger when a request has been created or re-opened.
Updated	The action will trigger when a request has been updated.
Closed	The action will trigger when a request has been closed or completed.

 
 

Available Body Field Variables

The following variables can be passed through the webhook, in the body of the request:
 

Variable Name	Data Type	Explanation
{{ATTENTION_OF_ID}}	Integer	ID of OfficeSpace user assigned to the request
{{ATTENTION_OF}}	String	Name of OfficeSpace user assigned to the request
{{CACHED_LAST_TRANSITION_ID}}	Integer	ID of the most recent interaction that was taken
{{CREATED_AT}}	YYYY-MM-DD UTC Date and Time	Creation time of the request
{{DELETED_AT}}	YYYY-MM-DD UTC Date and Time	Deletion time of the request
{{DUE_AT}}	YYYY-MM-DD UTC Date and Time	Time and date at which the request is due
{{EMAIL_CHANNEL_ID}}	Integer	ID for the email channel that the request was delivered to
{{FIRST_ACTION}}	String	Type of first action taken (e.g. Accepted, Declined, Delegated)
{{FIRST_ACTION_TARGET_TIME}}	Integer (number of minutes)	Time allocated to start working on the request
{{FLOOR}}	String	Name of the floor (according to OfficeSpace) that is impacted by the request
{{FLOOR_ID}}	Integer	ID number of the floor impacted by the request in OfficeSpace
{{HEXDIGEST}}	String	Internal identifier that links to the request externally
{{LAST_ACTIVITY}}	String	The last activity performed on the request
{{LAST_DELEGATION_ID}}	Integer	ID of the delegation action This ID is stored internally, but using this webhook, you can see the value.
{{LOCATION}}	String	Name of the location according to OfficeSpace
{{LOCATION_ID}}	Integer	ID number of the location impacted by the request, according to OfficeSpace
{{LOCATION_TYPE}}	String	Location type of the location impacted by the requested, according to OfficeSpace (e.g. Desk, Neighborhood)
{{MASTER_REQUEST_ID}}	Integer	ID number of the master request, when the request is merged with another.
{{ON_HOLD_BY}}	String	Name of the OfficeSpace user who placed the request on hold.
{{ON_HOLD_BY_ID}}	Integer	ID Number of the OfficeSpace user who placed the request on hold
{{ON_HOLD_STARTED_AT}}	YYYY-MM-DD UTC Date and Time	Date and time that a hold was started
{{REQUESTED_BY}}	String	Name of the user in OfficeSpace who made the request
{{REQUESTOR}}	String	Name of the user who made the request, as entered by the user in the request
{{REQUESTOR_EMAIL}}	String	Email address of the user who made the request, as entered by the user in the request
{{REQUESTOR_ID}}	Integer	ID of the user in OfficeSpace who made the request
{{REQUESTOR_USER_BY_EMAIL}}	String	Email address of the user in OfficeSpace who made the request
{{REQUEST_FEEDBACK_SURVEYS}}	Text	This returns the responses to the surveys sent upon completion of a request.
{{REQUEST_ON_HOLD_TIME_PERIODS}}	String in format: {:start=>>"YYYY-MM-DD UTC", :endstart=>"YYYY-MM-DD UTC"} (per period)	Start and end dates for the different periods when the request was put on hold
{{REQUEST_ID}}	Integer	ID number of the request in OfficeSpace
{{REQUEST_TYPE}}	String	Type of request, as defined by OfficeSpace
{{REQUEST_TYPE_ID}}	Integer	ID number of the request type, as defined by OfficeSpace
{{RESOLUTION}}	String	Type of resolution (e.g. 'Resolved', 'Unresolved')
{{RESOLUTION_TARGET_TIME}}	Integer	Time, in minutes, allocated to solve the request according to the SLA
{{SITE}}	String	Name of the site in OfficeSpace
{{SITE_ID}}	Integer	ID number of the site in OfficeSpace
{{SOURCE}}	String	Source of the request that was entered by OfficeSpace (e.g. visual_directory if Visual Directory was the source)
{{SUBJECT}	Text	Subject entered as part of the request
{{TIME_TO_FIRST_ACTION}}	Integer (number of minutes)	Time to the first action taken on the request, from when the request was opened
{{TOTAL_ON_HOLD_TIME}}	Float (time in minutes)	Total time that a request spent on hold The default value is 0.0, and a null value indicates that the request was not placed on hold.
{{UPDATED_AT}}	YYYY-MM-DD UTC Date and Time	Date and time when the request was last updated

 

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.

Request Subject: Need new ink in the 3rd Floor Printer
Request ID: 1597
Request Type: Emergency
Request Type ID: 3
Request Created at: 2022-02-18T18:46:51Z
Request Deleted at: 
Request Due at: 2022-02-19T19:00:00Z
Request Source: visual_directory
Requested By: Teegan Torres
Requestor: Teegan Torres
Requestor Email: ttorres@officespacesoftware.com
Requestor ID: 264
Currently Assigned: Korben Dorsey
Currently Assigned ID: 264
Last Transaction ID: 6246
Last Activity at: release
Last Delegation ID: 
Floor Label: Three
Floor ID: 751
Site: Austin
Site ID: 22
Location: Desk3345
Location ID: 144602
Location Type: Seat

 

Filtering by Request Type

When you create or edit a webhook for requests, you can utilize the Request Types dropdown menu to customize which Request Types will trigger a webhook. All Request Types are selected by default.

To individually select or deselect which webhooks will trigger an action, use the checkboxes in the dropdown menu. The counter at the top of the dropdown menu will reflect any change in the number of webhooks selected.



It should be noted that deselecting a Request Type will mean any newly-created Request Types must be manually added to the webhook. 

To select or deselect all available Request Types, use the Select all request types checkbox.  



Remember to save any changes that you make.