OVERVIEW

ImpexDocs's Webhook system allows real-time synchronization of critical data with external systems using REST-based endpoints. When a webhook is enabled for a company, ImpexDocs will automatically push updates related to configured modules (like Shipment, Booking, or EDN) to the specified external system.

This is ideal for integrating ImpexDocs with third-party platforms like ERP, logistics, or analytics systems.

What Triggers a Webhook?

A webhook is triggered when:

• The company admin has configured the webhook settings.
• A supported action (create or modify) occurs in a configured module.
• The system prepares and sends a POST request to the registered webhook receiver URL.

Payload Structure

{
  "resourceUri": "https://coreapi.impexdocs.com/api/v1/{SUBSCRIBED_MODULE_NAME}/{UNIQUE_RECORD_GUID}",
  "resourceId": "{MODULE_RECORD_GUID}",
  "resourceCode": "{MODULE_RECORD_CODE}",
  "eventDateUtc": "{UTC_DATE_TIME}",
  "eventType": "{EVENT_TYPE}",
  "eventCategory": "{MODULE_NAME}",
  "subEventType": "{MODULE_SECTION}",
  "companyId": {WEBHOOK_COMPANY_ID},
  "companyName": "WEBHOOK_COMPANY_NAME",
  "userId": {WEBHOOK_TRIGGERED_USER_ID},
  "userName": "{WEBHOOK_TRIGGERED_USER_NAME}",
  "additionalInfo": []
}

The additionalInfo field allows for optional custom payloads, configurable per company.

HTTP Method

• Method: POST
• Content-Type: application/json
• ImpexDocs will initiate requests to your REST endpoint when events occur.

Authentication

You can secure your webhook endpoint using either of the following optional methods:

• Basic Authentication
  Provide a Username and Password which ImpexDocs will use to authenticate via Basic Auth: User and Password.

• Header Key-Based Authentication
  You may also configure custom HTTP headers, such as:

  • X-Api-Key: your-secret-key
  • Authorization: Bearer your-token

These headers will be included with every webhook request.

Response & Retry Policy

• Your webhook receiver must return a 2xx HTTP status code within 5 seconds.
• If the request fails (timeout, 4xx or 5xx response), ImpexDocs will retry up to 3 times using incremental delay.

Supported Action Types

• create: Triggered when a new record is created
• modify: Triggered when a record is updated

Supported Modules and Events

• Shipment: All (No Selection)
• Booking: All (No Selection), Location Changed, Header Changed, Date Changed
• EDN: All (No Selection), Header Changed

SETUP

How to Enable Webhooks

• Login to ImpexDocs.
• Navigate to Settings → Webhook → Setup.
• Enter the Webhook Receiver URL.
• (Optional) Add any required Header Key/Value pairs for security.
• Switch to the Authentication tab to provide a Username and Password (optional).
• Enable the webhook for the desired modules and events.
• (Optional) Add any additional payload fields you wish to send.

Once enabled, ImpexDocs will begin sending event notifications automatically.

Note: Make sure you have admin right while enabling Webhook