What is a Webhook?

A webhook is an automatic action that takes place when a certain event occurs. This is typically the act of pushing data from Impexium to an outside program. For example, when a customer registers for a course in Impexium, a webhook can push that customer’s data to an outside program, such as an LMS (learning management system).

Useful Terms

When working with webhooks, you may encounter the following terms:

  • Type: The type of event that triggers the Web Hook. It can be an Event Registration, Account Creation, or the purchase of a specific product.

  • Secret: This is a security tool for the vendor to whom the webhook is sent.

  • JSON Payload: Displays an example of what information will be sent over, which is dictated by the Type (see above).

  • URI: This is the URI provided by the vendor receiving the web hook via their Listener Endpoint.

  • Description: A description of the webhook’s purpose.