API Reference

Webhooks

📘

Testing phase

The webhooks feature is currently in testing and available behind a feature flag. Would you like to try it out? Please reach out to us through api[at]xentral.com

A webhook allows you to send information about events happening in your Xentral instance to an external system. For example, you could get a notification in your application every time a new sales order is created. The information is sent to your external system via an HTTP POST request.

Keep in mind: the limit for destination URL is 255 characters

The payload of the POST request follows the following structure:

{
    "type": "com.xentral.EVENTTYPE.vX",
    "body": {
        ...
    }
}

Webhook events

view this page in full at thislink

Below you can find the specification of our event payloads which you can get with the usage of our webhook system.