Insites Docs Instance EcommerceEcommerce Webhooks

Ecommerce Webhooks

Last updated on August 01, 2024.

A webhook is an HTTP-based callback function that enables direct communication between web applications. It is distinct from APIs in that it eliminates the need for polling by shifting the communication responsibility to the server, avoiding repetitive client calls to check for events. Webhooks allow one application to send automatic notifications or trigger actions in another application whenever a specific event occurs.

In the e-commerce module, webhooks are essential for tasks such as sending notifications and automating workflows triggered by events like order creation or updates. For example, you can use a webhook for an order creation event to update inventory or automatically send notifications in real-time.

This document discusses the following topics

  • Updating a webhook
  • Enabling a webhook
  • Disabling a webhook

Updating a webhook

To update a webhook:

  1. Navigate to Ecommerce from the main menu.
  2. Select Webhooks.
  3. Select the event you want to modify.
  4. Select Edit.
  5. Fill out the form for modifying a webhook.

These are the input requirements and descriptions for updating a webhook:

Input LabelTypeRequiredDescription
Enable Webhook Toggle No Enables or disables the webhook.
URL Input Field No The uniform resource locator (URL) used by the webhook to deliver data or trigger actions in a recipient application.

Enabling a webhook

To enable a webhook:

  1. Navigate to Ecommerce from the main menu.
  2. Select Webhooks.
  3. Select the event with the webhook you want to enable.
  4. Enable the webhook using the toggle.
  5. Select SAVE.

Disabling a webhook

To disable a webhook:

  1. Navigate to Ecommerce from the main menu.
  2. Select Webhooks.
  3. Select the event with the webhook you want to disable.
  4. Disable the webhook using the toggle.
  5. Select SAVE.
Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.