Securing Webhooks

To add an extra layer of security to your webhooks, we have introduced the x-API-key feature.
When enabled, each webhook request will include a custom header (x-API-key) that you define.
Your server can then validate this key to ensure the request came from us — preventing unauthorized systems from sending fake webhook payloads.

How This Secures the Webhook

Without verification, anyone who knows your webhook URL could send fake requests that look real.
By adding a secret x-API-key header:

1. We include the secret key in every webhook call we send to you.
2. You verify this key on your server before processing the payload.
3. Requests without the correct key (or with an incorrect one) are rejected.

This means that even if your webhook URL is exposed, malicious parties cannot successfully send data without knowing your secret key.

How to Enable the Security Feature

1. Go to your Settings > API > Configure Webhook.

2. Toggle "Add Custom Header" to enable it.

3. In the x-API-key field, enter a secret key (alphanumeric, 13–60 characters).

   

4. Click "Save Webhook" to save changes.

From now on, all webhook payloads will include the x-API-key in the request header.

Example x-api-key:

x-api-key: a1p2z5b7v68b9112234

How to Edit/Update the x-API-key

1. Click in the x-API-key field and update the value.
2. Click "Update Webhook" to save.
3. Future webhook calls will carry the new key.

Webhook Payload Example

Header:  
x-api-key: a1p2z5b7v68b9112234

Body:  
{  
    "id": \<Number(20)>,  
    "data": {  
        "orderId": \<Number(11)>,  
        "poNumber": \<String(100)>,  
        "orderDate": \<String(19)>,  
        "deliveryStatus": \<String(9)[Delivered|Canceled]>  
    },  
    "createdAt": \<String(19)>  
}  

Legend
<DataType(size)> → Data type and maximum size of the field.

Parameters