Skip to main content

Webhook Events

The Webhook Events page allows for users with the 'Administration' role to create system webhooks by collection.

What is a webhook?​

A webhook is a a reverse API query that is executed when a specified system event occurs.

Example​

  • Event: When a contract is created
  • Webhook: Send contract to external API endpoint, such as a terminal management system (TMS)

Description of Returned Results​

  • Name - Name of Webhook Event
  • Collection - The collection the Webhook Event applies to
  • Endpoint - The endpoint to send the data to
  • Status - Enabled/Disabled