How can we help?

A custom app can have actions created that send data to a defined endpoint when a consignment moves into a particular status.

These actions live in the Actions tab inside the custom app.

This tab will list any actions that have been defined for this custom app already.

Edit existing actions by tapping on them or create a new action by using the Add Action button.

The actions tab of the custom app

Creating an Action

Begin by giving your action a Name. 

Configurations

An action can support the below configuration: 

Allow Repeat Executions

Always trigger webhook when consignment enters this status

1. If you wish the action to execute whenever the consignment moves into this status, select this checkbox
2. If the checkbox is deselected, then an export will only fire if the consignment hasn't yet been exported by this

Concurrent Execution Enabled

• The action remains repeatable, but Consignly waits until the previous execution finishes.
• Duplicate triggers while it is pending/executing are skipped.

• Multiple executions for the same action and context can run/queue concurrently.
• This is useful when events arrive quickly and each must be processed.
• Your external Custom App must safely handle parallel requests, including ordering and duplicate effects.

Manual Execution Enabled 

If you want to manually execute the integration, select the checkbox. 

Webhook Endpoint

The action requires an endpoint to be provided with which to POST the data to.

Enter the URL, and optionally enter a signing key in the Signing Key 1 or Signing Key 2 field.

Action Trigger - Event Type

An action trigger requires the following information:

1. Event Type 

   1. choose from the available Consignment Events, Consignment Import Events, or Integration Events. 

Consignment Events 

Consignment Events have the following configuration fields available: 

1. Consignment Type (optional)
2. Consignment Status (optional)
   1. The status that you wish the action to execute in
3. Client Partner (optional)
   1. Target the export for consignments for the selected Client Partner only by selecting an item from this list
4. Carrier Partner (optional)
   1. Target the export for consignments for the selected Carrier Partner only by selecting an item from this list

5. Warehouse (optional)

   1. Target the export for consignments for the selected Warehouse only by selecting an item from this list

   6. Container (optional)

   Target export for containerised goods or non-containerised goods

   7. Service Types (optional) 

   Target exports for consignments for the selected service type. 

    

Payload Definition

The Consignment Export action will push a payload to the defined endpoint.

• OrganisationId: The identifier for your organisation (uuid)
• ConsignmentId: The identifier of the consignment (uuid)
• ClientPartnerId: The identifier of the Client Partner for this consignment (uuid)
• CarrierPartnerId: The identifier of the Carrier Partner for this consignment (uuid, nullable)
• WarehouseId: The identifier of the Warehouse for this consignment (uuid)
• Type: Inwards, Outwards, Point to Point (integer)
• Status: The current status of the consignment (integer)
• PreviousStatus: The previous status of the consignment (integer)
• IsVoid: Has the consignment been voided (boolean)

The shape of the payload is a JSON object, based on the below:

{
  "organisationId": "00000000-0000-0000-0000-000000000001",
  "consignmentId": "00000000-0000-0000-0000-000000000002",
  "clientPartnerId": "00000000-0000-0000-0000-000000000003",
  "carrierPartnerId": null,
  "warehouseId": "00000000-0000-0000-0000-000000000004",
  "type": 1,
  "status": 4,
  "previousStatus": 1,
  "isVoid": false
}

Schedule Events 

Schedule Events have the following configuration fields available: 

1. Schedule Status (optional)  
   1. The status that you wish the action to execute in
2. Partner (optional)

   1. Target the action for consignments for the selected Client Partner only by selecting an item from this list

       

Payload Definition

The Schedule Event Action will push a payload to the defined endpoint.

• OrganisationId: The identifier for your organisation (uuid)
• PartnerId: The identifier of the Client Partner for this consignment (uuid)
• PartnerScheduleId: The identifier of the Client Partner's schedule that triggered the export (uuid)
• Status: The current status of the schedule (integer)

The shape of the payload is a JSON object, based on the below:

{
  "organisationId": "00000000-0000-0000-0000-000000000001",
  "partnerId": "00000000-0000-0000-0000-000000000002",
  "partnerScheduleId": "00000000-0000-0000-0000-000000000003",
  "status": 2
}

Removing an Action

To remove an existing action, tap into the action and using the action menu, choose Remove action.

The remove action menu item