What are webhooks?

Webhooks allow you to subscribe to certain events that happen in ImpexDocs. When one of these events are triggered, we’ll send a HTTP POST payload to the webhook’s configured URL.

Webhooks are configured on a company basis, and we will send you events for every configured module. Webhooks can be created on all available modules in ImpexDocs.

Action and Triggers

The Action and Triggers section allows users to configure when a webhook should be triggered. This ensures external systems receive real-time updates when important information changes.

Booking

Actions: Actions define which type of booking operation will trigger the webhook.

Create: Enable this option to trigger the webhook when a new booking is created in the ImpexDocs.
- Trigger On: This dropdown allows you to define when the webhook should be fired during the create process, and it is optional. Typical options may include below.
  - When Shipment Linked: A webhook will be triggered when a new booking is created and linked to an Export Shipment.
Modify: Enable this option to trigger the webhook when an existing booking is modified.
- Trigger On: This dropdown allows you to define when the webhook should be fired during the modify process, and it is optional. Typical options may include below.
  - When Shipment Linked: A webhook will be triggered when an existing booking is modified and linked to an Export Shipment.

Events : Events specify which booking fields or attributes must change to trigger the webhook when Modify is enabled.

You can select one or multiple events.

Location Changed: Triggers the webhook when pickup or delivery location is modified. This includes below property of booking.

i. Departure Vessel

ii.Departure Voyage

iii.Departure Empty Depot

iv.Name Of Shipping Line/Airline Code

v.Shipping Line/Airline Desc

vi.Port Of Loading Code

vii.Port Of Loading Desc

viii.Terminal Code

ix.Terminal Desc

x.First Discharge Port Code

xi.First Discharge Port Desc

xii.Final Port Of Discharge Code

xiii.Final Port Of Discharge Desc

xiv.Final Destination Code

xv.Final Destination Name

Header Changed: Triggers when general booking information is updated. This includes below property of booking

i. Booking Number

ii.Booking Status

iii.No. Of Containers

iv.Container Description

v.Container Type

vi.Temperature

vii.Temperature Unit

viii.Air Flow/Vent

ix.Air Flow/Vent Unit

x.Humidity (%)

Date Changed: Triggers when shipment-related dates are modified.

i. Cargo Cutoff Date

ii.Reefer Cutoff Date

iii.Terminal Receiving Date Time

iv.Estimated Arrival Date(ETA)

v.Transhipment (ETD)

vi.Estimated Departure Date (ETD)

vii.Actual Departure Date (ATD)

viii.Actual Arrival Date (ATA)

ix.Transhipment ETA

x.Transhipment ATA

xi.Transhipment ATD

Shipment Changed: Triggers when shipment details are modified.

i.Shipment Number

Rate Changed: Triggers when freight or pricing information changes

i. Quote Reference

ii.Currency

iii.Quoted Rate Per Container

iv.Total

v.Tons Per FCL

vi.Quantity MT

vii.Exchange Rate

viii.Freight Local

ix.Freight USD

x.Total Freight USD

xi.Freight Per Ton

xii.Comments

Additional Payload: The Additional Payload section allows users to include extra Booking fields in the webhook request body when the webhook is triggered.

When events are selected in the Events section (such as Location Changed, Date Changed, Shipment Changed, etc.), the system automatically identifies the related booking fields associated with those events. These fields will be displayed in the Additional Payload list.

How It Works:

The user selects one or more Events in the Booking webhook configuration.
The system displays all related booking fields in the Additional Payload section.
The user can select any of these fields.
When the webhook is triggered, the selected fields and their current values will be included in the Webhook Request Body sent to the external system.

Purpose

This feature provides flexibility by allowing external systems to receive only the specific data fields they require, without sending the entire booking object.

Note: Booking Number is a mandatory field required to trigger the webhook.

EDN

Actions: Actions define which type of EDN operation will trigger the webhook.

Create: Enable this option to trigger the webhook when a new EDN is created in the ImpexDocs.
Modify: Enable this option to trigger the webhook when an existing EDN is modified.

Events : Events specify which EDN fields or attributes must be changed to trigger the webhook when Modify is enabled.

You can select one or multiple events.

Header Changed: Triggers when general EDN information is updated. This includes below property of EDN.

i. EDN Number

ii.Shipment Number

iii.Exporter Reference

iv.EDN Status

v.EDN Status DateTime

Additional Payload: The Additional Payload section allows users to include extra Edn fields in the webhook request body when the webhook is triggered.

When events are selected in the Events section (such as Header Changed.), the system automatically identifies the related edn fields associated with those events. These fields will be displayed in the Additional Payload list.

How It Works:

The user selects events in the EDN webhook configuration.
The system displays all related EDN fields in the Additional Payload section.
The user can select any of these fields.
When the webhook is triggered, the selected fields and their current values will be included in the Webhook Request Body sent to the external system.

Purpose

This feature provides flexibility by allowing external systems to receive only the specific data fields they require, without sending the entire EDN object.

Note: EDN Number is a mandatory field required to trigger the webhook.

Shipment

Actions: Actions define which type of shipment operation will trigger the webhook.

Create: Enable this option to trigger the webhook when a new shipment is created in the ImpexDocs.
- Trigger On: This dropdown allows you to define when the webhook should be fired during the create process, and it is optional. Typical options may include below.
  - Shipment Status: A webhook will be triggered whenever a new shipment is created **and **its status matches the specified value(s).
  - Trigger Values: Enter one or more status values separated by || (for example: 1 || 2)
Modify: Enable this option to trigger the webhook when an existing shipment is modified.
- Trigger On: This dropdown allows you to define when the webhook should be fired during the modify process, and it is optional. Typical options may include below.
  - Shipment Status: A webhook will be triggered whenever existing shipment is modified **and **its status matches the specified value(s)
  - Trigger Values: Enter one or more status values separated by || (for example: 1 || 2)

Events : Events specify which shipment fields or attributes must change to trigger the webhook when Modify is enabled.

You can select an event type.

Note:

The Event option is company-specific and currently available only for Tyre Cycle. For other companies, only the Modify option should be selected

Tyre Cycle: Triggers the webhook when general shipment information is updated. This includes below property of shipment.

i. Shipment Number

ii.Shipment Status

iii.Booking Number

iv.Customer

v.General Product Description

vi. Incoterms

vii.Forwarding Agent

viii.Country Of Destination

ix.Departure Vessel

x.Departure Voyage

xi.Allocated Containers

xii.Final Destination

xiii.Shipping Line

xiv.Cargo Cutoff Date

Additional Payload: The Additional Payload section allows users to include extra Shipment fields in the webhook request body when the webhook is triggered.

When events are selected in the Events section. The system automatically identifies the related shipment fields associated with those events. These fields will be displayed in the Additional Payload list.

How It Works:

The user selects one or more Events in the Shipment webhook configuration.
The system displays all related shipment fields in the Additional Payload section.
The user can select any of these fields.
When the webhook is triggered, the selected fields and their current values will be included in the Webhook Request Body sent to the external system.

Purpose

This feature provides flexibility by allowing external systems to receive only the specific data fields they require, without sending the entire shipment object.

Note: Shipment Number is a mandatory field required to trigger the webhook.

RFP

Actions: Actions define which type of RFP operation will trigger the webhook.

Create: Enable this option to trigger the webhook when a new RFP is created in the ImpexDocs.
Modify: Enable this option to trigger the webhook when an existing RFP is modified.

Events : Events specify which RFP fields or attributes must be changed to trigger the webhook when Modify is enabled.

You can select one or multiple events.

Summary Changed: Triggers when general RFP information is updated. This includes below property of RFP.

i. RFP Number

ii.Shipment Number

iii.EDN

iv.EPN

v.Exporter Number

vi.ExporterNumberDesc

vii.Exporter Reference

viii.Customer Reference

ix.RFP Status

x.RFP Status DateTime

xi.Primary Certificate

xii.Secondary Certificate

Additional Payload: The Additional Payload section allows users to include extra RFP fields in the webhook request body when the webhook is triggered.

When events are selected in the Events section (such as Summary Changed.), the system automatically identifies the related RFP fields associated with those events. These fields will be displayed in the Additional Payload list.

How It Works:

The user selects one or more Events in the RFP webhook configuration.
The system displays all related RFP fields in the Additional Payload section.
The user can select any of these fields.
When the webhook is triggered, the selected fields and their current values will be included in the Webhook Request Body sent to the external system.

Purpose

This feature provides flexibility by allowing external systems to receive only the specific data fields they require, without sending the entire RFP object.

Note: RFP Number is a mandatory field required to trigger the webhook.

CRN

Actions: Actions define which type of CRN operation will trigger the webhook.

Create: Enable this option to trigger the webhook when a new CRN is created in the ImpexDocs.
Modify: Enable this option to trigger the webhook when an existing CRN is modified.

Events : Events specify which CRN fields or attributes must be changed to trigger the webhook when Modify is enabled.

You can select one or multiple events.

Header Changed: Triggers when general CRN information is updated. This includes below property of CRN.

i. CRN Number

ii.Shipment Number

iii.EDN Number

iv.Internal CRN ID

v.Exporter Reference

vi.Customer Reference

vii.ModeOfTransport

viii.Date Of Departure

ix.Status

x.Status DateTime

Additional Payload: The Additional Payload section allows users to include extra CRN fields in the webhook request body when the webhook is triggered.

When events are selected in the Events section (such as Header Changed.), the system automatically identifies the related CRN fields associated with those events. These fields will be displayed in the Additional Payload list.

How It Works:

The user selects Events in the CRN webhook configuration.
The system displays all related CRN fields in the Additional Payload section.
The user can select any of these fields.
When the webhook is triggered, the selected fields and their current values will be included in the Webhook Request Body sent to the external system.

Purpose

This feature provides flexibility by allowing external systems to receive only the specific data fields they require, without sending the entire CRN object.

Note: CRN Number is a mandatory field required to trigger the webhook.

Notification Payloads

The JSON payload will be a consistent format for all module of actions, and each action will consist of

JSON Attribute	Description
ResourceUri	This is the API URI that can be used to retrieve the complete details of the record through the REST API, if required.
ResourceId	This is the internal ImpexDocs ID, which can be stored in an external system if required.
ResourceCode	This is the internal ImpexDocs ID, which can be stored in an external system if required.
EventDateUtc	When a record is created or modified in the system.
EventType	The type of selected action that occurred (for example, `Add` for Create action or `Update` for Modify action).
EventCategory	The category (module name) of the event that occurred (for example, `SHIPMENT`, `RFP`, `EDN`, or `BOOKING`). You will only retrieve events from categories that your webhook is subscribed to.
SubEventType	The type of sub-event ( Actually hold Event Name) that occurred, for example `Header Changed` or `Booking Changed`.
CompanyId	The ID of the company where the event happened.
CompanyName	The name of the company where the event happened.
UserId	The ID of the user who triggered the event or performed the action.
Username	The name of the user who triggered the event.
AdditionalInfo	Additional data configured by the end user during webhook setup.