Skip to main content

Overview

Information

Enad allows you to register for webhook events sent over HTTP.

Supported events

  1. Product
  2. Variants
  3. Tags
  4. Categories
  5. Markets
  6. Store Groups
  7. Prices
  8. Stocks

Ack deadline

A webhook will be dropped and marked as failure if there is no 200 response within 15 seconds. It will be retried later on.

Events structure

All of our events start with the 2 JSON keys event_type and payload. event_type describes the type of event, and payload is the data.

The event_type is structured as category.type of event.

{
"event_type": "something.happend",
"payload": {
"x": "y"
}
}

Authentication

We only support authentication using a header key and a header value. These values will be set in the request headers before sending the request.

Header keyHeader value
AuthorizationBearer xqwerty12345

The header key is dynamic, meaning it can also be x-api-key or api-key.

Authorization is requried.

Retry policy

We will retry events up to 5 times before considering them a failure.

Use Cases

Some use cases for webhook events are:

  1. Revalidate frontend.
  2. Stock and price updates in external systems.
  3. Product information updates in external systems.
  4. Alerts

Managing events

Register a webhook by:

  1. Logging into Enad Admin.
  2. Clicking the app to which you want to add a webhook.
  3. Going to System -> Integrations -> Add new integration and following the instructions in the dialog.