Webhooks for Safeguard

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 ensure that a particular action in OfficeSpace relies on the successful completion of a Safeguard form, you can configure a webhook to achieve this result. To find the Webhooks area, go to the Admin module, which is accessible from the Hamburger menu.



To learn more about creating and managing webhooks, please see Introduction to Webhooks.

Available Safeguard Webhooks
Available Body Field Variables
Sample Webhook
Sample Output to Endpoint

 

Available Safeguard Webhooks

The table below lists the available safeguard webhook types:
 

Safeguard Result	Action
Safeguard Result: Created	This webhook will trigger when a Safeguard Assessment has been created.
Safeguard Result: Passed	This webhook will trigger when a user has successfully passed a Safeguard Assessment.
Safeguard Result: Failed	This webhook will trigger when a Safeguard Assessment has been failed.

 

 

Available Body Field Variables

The table below lists the available body variables:
 

Variable	Description
{DEPARTMENT}}	Employee department
{{EFFECTIVE_DATE}}	Date of Safeguard form submission (Month Day, Year)
{{EFFECTIVE_TIME}}	Time of Safeguard form submission (HH:MM, 12hr)
{{EMAIL}}	Employee email address
{{EMPLOYEE_ID}}	Employee OSS Identifier
{{EXPIRATION_DATE}}	Safeguard attestation expiry date (Month Day, Year)
{{EXPIRATION_TIME}}	Safeguard attestation expiry time (HH:MM, 12hr)
{{FIRST_NAME}}	Employee first name
{{LAST_NAME}}	Employee last name
{{NAME}}	Full employee name
{{PASSED}}	SG attestation form pass/fail (boolean: true/false)
{{SITE_ID}}	Site identification #
{{SITE_NAME}}	Site name
{{SAFEGUARD_ID}}	Unique numeric identifier for triggered webhook SG event

 

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.

{
  "event": "Safeguard Result: Fail",
  "employee": {
    "first_name (string)": "Teegan",
    "last_name (string)": "Torres",
    "name (string)": "Teegan Torres",
    "department (string)": "Collation Group",
    "email (string)": "ttorres@emailofficespace.com",
    "employee_id (string)": "INI_ID_000042"
  },
  "result": {
    "passed (boolean)": false,
    "effective_date (string)": "October 13, 2021",
    "effective_time (string)": "12:00 AM",
    "expiration_date (string)": "October 13, 2021",
    "expiration_time (string)": "11:59 PM"
  },
  "location": {
    "site_id (integer)": 11,
    "site_name (string)": "Austin Site"
  }
 }