Skip to content
  • There are no suggestions because the search field is empty.

Webhooks

Table of Contents

Purpose

Webhooks are available for most entity changes, and can be configured based on conditions (ie: specific customer, specific status etc.). The standard payload, triggers and authentication are provided free of charge. However, if you require any customisation then this is at an additional cost and it the Integration team will be required to analyse the requirements and quote for the scope of work. 

Standard Webhooks 

The standard payload, triggers and authentication are provided free of charge. 

Standard Webhook Payloads 

Below is detailed information regarding the standard webhook payloads for each entity, which are available at no extra cost. Additionally, we offer custom payloads, which are subject to additional charges see Custom Webhooks for more information. 

Standard Authentication 

For standard authentication, an API-Key header parameter can be utilised. Should there be a need for an oAuth expiry bearer token, this option is available for a fee.

Standard Webhook Triggers 

The standard webhooks triggers are listed below. These triggers are provided complimentary. Custom triggers or conditions, such as triggering only on certain statuses, will however incur charges see Custom Webhooks for more information.

  • Order creation
  • Order status change. 

Standard Webhook Requirements 

Requirements for the standard webhooks are as follows

  • URL endpoints
  • API-Key (if required)

How to get set up for standard Webhooks

Please reach out to the Integration team here with the standard webhooks you would like set up. 

Our team is committed to setting up standard webhooks within 5 business days.

Custom Webhooks

Custom Webhooks can be set up with custom payload and trigger conditions. 

Please reach out to the Integration team here with your requirements. 

For custom webhooks, the timeline extends to 15 days following the approval of the quote.

Custom payloads or triggers will necessitate a comprehensive analysis and scoping to fully understand your needs. This would include documentation of the proposed workflow and message structure.