<img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=691116991096043&amp;ev=PageView&amp;noscript=1">
Skip to content
  • There are no suggestions because the search field is empty.

Webhooks

This article provides an overview of webhooks and how they can be configured to send event notifications to other applications.

Sections in this article:

Watch the video for a demonstration of webhooks:

 

What are Webhooks?

If you are familiar with coding, you can use webhooks to be notified automatically when a contract or vendor status changes in Gatekeeper.

A webhook allows one application to send event notifications to another application in real time.
For example, you might want to notify a third-party system, such as an ERP, when a new vendor is approved in Gatekeeper. The third-party system can then retrieve data about that vendor via the API.

Instead of making repeated calls to pull data frequently from the Gatekeeper API, Gatekeeper automatically sends a notification when a specified event occurs. This allows events to be synchronised to your other apps instantly while reducing unnecessary API traffic.

Note: This feature is only available on Enterprise Plans. 

Supported Webhook Events

Gatekeeper can send notifications for the following events:

  • Vendor Created

  • Vendor Updated

  • Vendor Approval Status Updated

  • Vendor Status Updated

  • Contract Created

  • Contract Updated

  • Contract Approval Status Updated

  • Contract Status Updated

  • Spend Created

  • Spend Updated

Configure Webhooks

To create a webhook in Gatekeeper:

  1. From the navigation menu, expand Settings, then click Configuration.

  2. Click Webhooks.

  3. Click Add Subscription.add subscription

  4. Complete the following details:

    1. Target URL - The URL where Gatekeeper will post event notifications.

    2. Event Subscriptions - Select the checkboxes for the events you want to subscribe to. You can either create separate subscriptions for different events, or select multiple events into one subscription.

  5. Once finished, click Save.

Access the Secure Token

Gatekeeper secures webhooks using challenge-response authentication. This verifies that the recipient is authorised to receive the event notifications.

The Secure Token can be copied when configuring the subscription in Gatekeeper, and entered into the receiving system's webhook configuration. The third-party system can then validate that incoming event notifications were sent from Gatekeeper by checking that the secure token matches.

secure token

View Webhook Events

Once a webhook is configured, you can monitor the notifications sent from Gatekeeper to your target URL. 

To do this, from the Webhooks Configuration page, click View in the Events column. This displays a log of events, which can be used to verify that events are sent as expected and to help diagnose any issues. Click the 3 dots to view further details.

For more information, see the Gatekeeper API article  or contact your Customer Success Manager.