Beta-Release Notes

Event Driven Webhooks will incur charges in some cases. Contact the Customer Success Team to ask about charges and to activate this feature. If you want to use it you will need to contact the Customer Success team.

About Event Driven Webhooks

Event driven webhooks allows you to listen to events that happen to records in EvolutionX and notify a third-party RESTFull API Endpoint. This makes it much easier to integrate your EvolutionX store with other systems and setup follow-up actions or synchronize records based push events rather than poling.

Lets look at some examples that can benefit from Event Driven Webhooks:

When a customer self registers as a business account on your EvolutionX website you automatically add the corresponding record to your ERP and update the EvolutionX record with the new ERP ID. This will prevent the need for staff to manually intervene other than to approve a credit request.
A signup to your newsletter can call an event to update your CRM or email marketing software and add them to a marketing list.
An order placed on the website can be pushed through an Event Driven Webhook to your order processing software for fulfilment.
A notification of new orders can be setup to Alexa, Google Home or other service to notify staff of an order from a customer.

Features of EvolutionX Event Driven Webhooks

Many Webhook targets can be added so that multiple systems can subscribe to events.
Allows subscribing to multiple record events for each webhook. These events serve as the triggers for the webhook.
Provides for a custom target URL, query parameters and headers for each webhook. This allows you to send the webhook with an authorization key or other requirements.
Signs each webhook using a secret key so you can validate that it was sent from EvolutionX and has not changed in flight.
Includes an Idempotent event ID to so you can track if the event has been processed and prevent duplication.
Webhooks can be created using the API or the Admin.
A full log of events, related events, and webhook request logs can be viewed through the EvolutionX Admin Developer tools.

Webhook Subscriptions

You can subscribe a webhook to an event using the API or Admin.

Event and Webhook Logs

Event logs live for 60 days and include details such as:

Event ID — unique ID of this event
Object type and ID — e.g. order created with ID 1000
Event date and time — stored as a Unix Date in UTC
Source User — which application and user ID made the change, e.g. storefront user with ID 1000

Webhook Attempt Header Logs live for 60 days and include details such as:

Request ID — unique ID of this attempt log
Attempt date and time — stored as a Unix Date in UTC
Event ID — the event which triggered the attempt
Response Status — the response status code received during the attempt, e.g. 200 (success)
Timing — the time it took to receive the response
Request URI — the domain and path which was the target of the webhook
Request Method — the type of request, e.g. POST or GET

Webhook Attempt Payload Logs live for 15 days and include details such as:

Request ID — unique ID of this attempt log
Request JSON — the data submitted during the attempt
Response JSON — the data received as the response