Event subscription payload definitions – Consignly

Consignly supports several different events and therefore several different payload definitions.

The event payload will be wrapped in a standard object, with the event property of the payload different for each type of event.

The wrapping payload is as follows:

EventType: Identifies the type of event that the payload relates to
Event: An object with details of the event being fired
Timestamp: An integer representing ticks.

{
  "eventType": "name-of-event",
  "event": {},
  "timestamp": 638306981121668077
}

Quick Links

Webhook Verification (Optional: Direct API-Method)

Note: This method is only needed when registering webhooks using the Consignly API.

Registering webhooks using the Consignly web portal does not require a verification step.

If you intend to interact with the API directly, you will need to perform a verification step in order to register a webhook.

When you first setup the webhook, Consignly will send your webhook address an object.

{
  "EventType": "webhook-verification",
  "Event": {
    "VerificationId": "00000000-0000-0000-0000-000000000000"
           },
  "Timestamp": "xxxxx"
}

Your webhook address needs to take this, extract the verification Id and return a 200 response with the following:

{
  "VerificationId": "00000000-0000-0000-0000-000000000000"
}

This allows Consignly to verify that you are in control of the webhook and complete the verification step.

Payload definitions

Consignment Created

Fires: when a consignment is created.
Scoped: to the Client and Carrier selected in the subscription.
Event Type: consignment-created

Event:

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)
OriginAddress: The address of the origin
- WarehouseId: The identifier of the Warehouse if the origin address is a warehouse (uuid, nullable)
- Location: The geocoordinates of the address
  - Lat: The latitude
  - Lng: The longitude
DestinationAddress: The address of the destination
- WarehouseId: The identifier of the Warehouse if the destination address is a warehouse (uuid, nullable)
- Location: The geocoordinates of the address
  - Lat: The latitude
  - Lng: The longitude
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "consignment-created",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "consignmentId": "00000000-0000-0000-0000-000000000002",
    "consignmentNumber": "JWBL-000000-IN",
    "clientPartnerId": "00000000-0000-0000-0000-000000000003",
    "carrierPartnerId": null,
    "type": 1,
    "enteredDate": "2023-01-01T00:00:00+00:00",
    "originAddress": {
      "warehouseId": null,
      "location": {
        "lat": -43.0000000,
        "lng": 172.0000000
      }
    },
    "destinationAddress": {
      "warehouseId": "00000000-0000-0000-0000-000000000004",
      "location": {
        "lat": -43.0000000,
        "lng": 172.0000000
      }
    },
    "originConnectionId": "LUerlbPQBLNzdf6oIJrZ0g"
  },
  "timestamp": 638306981121668077
}

Consignment General Updated

Fires: when a consignment's general card is updated.
Scoped: to the Client and Carrier selected in the subscription.
Event Type: consignment-general-updated

Event:

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)
ReferenceNumber: The reference number of this consignment (string, nullable)
DateEntered: The date that the user chose to enter the consignment into Consignly (date, no time component, local to the user that entered it)
ExpectedArrivalDateTime: The date/time of the expected arrival of the inwards consignment to the warehouse (date/time, UTC)
ExpectedDispatchDateTime: The date/time of the expected dispatch of the outwards consignment to the warehouse (date/time, UTC)
DefaultReceiveWarehouseLocationId: The identifier of the location that the consignment may be receipted into (uuid, nullable)
DefaultReceiveWarehouseLocationName: The name of the location that the consignment may be receipted into (string, nullable)
DefaultDispatchWarehouseLocationId: The identifier of the location that the consignment may be dispatched from (uuid, nullable)
DefaultDispatchWarehouseLocationName: The name of the location that the consignment may be dispatched from (string, nullable)
PickingInstructions: Specific picking instructions supplied (string, nullable)
ReceiversReference: The receiver's reference of this consignment (string, nullable)
SendersReference: The sender's reference of this consignment (string, nullable)
PONumber: The PO Number of this consignment (string, nullable)
SONumber: The SO Number of this consignment (string, nullable)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "consignment-general-updated",
  "event": {
    "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",
    "referenceNumber": "Order ABC123",
    "dateEntered": "2023-01-01T00:00:00+00:00",
    "expectedArrivalDateTime": "2023-01-01T17:30:22.666+00:00",
    "expectedDispatchDateTime": null,
    "defaultReceiveWarehouseLocationId": null,
    "defaultReceiveWarehouseLocationName": null,
    "defaultDispatchWarehouseLocationId": null,
    "defaultDispatchWarehouseLocationName": null,
    "pickingInstructions": null,
    "receiversReference": null,
    "sendersReference": null,
    "poNumber": null,
    "soNumber": null,
    "originConnectionId": "LUerlbPQBLNzdf6oIJrZ0g"
  },
  "timestamp": 638306981981916216
}

Consignment Route Updated

Fires: when a consignment's route card is updated.
Scoped: to the Client and Carrier selected in the subscription.
Event Type: consignment-route-updated

Event:

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)
Type: Inwards, Outwards, Point to Point (integer)
Status: The current status of the consignment (integer)
OriginAddress: The address of the origin
- WarehouseId: The identifier of the Warehouse if the origin address is a warehouse (uuid, nullable)
- Location: The geocoordinates of the address
  - Lat: The latitude
  - Lng: The longitude
DestinationAddress: The address of the destination
- WarehouseId: The identifier of the Warehouse if the destination address is a warehouse (uuid, nullable)
- Location: The geocoordinates of the address
  - Lat: The latitude
  - Lng: The longitude
CarrierName: The name of the Carrier Partner (string, nullable)
CarrierReference: The reference for the carrier (string, nullable)
ContainerSize: The size of the container (integer, nullable)
ContainerType: The type of the container (integer, nullable)
ContainerStatus: The status of the container (integer, nullable)
ContainerNumber: The specified container number on the consignment (string, nullable)
ContainerReceivedDate: The date that the container was received (date/time, no time component, local to the user that entered it, nullable)
ContainerReturnedDate: The date that the container was returned (date/time, no time component, local to the user that entered it, nullable)
ContainerYardAddressId: The identifier of the container yard address used in the route (uuid, nullable)
ContainerYardName: The name of the container yard used in the route (string, nullable)
ContainerYardAddressText: The address text of the container yard used in the route (string, nullable)
ContainerYardLocation: The geocoordinates of the container yard
- Lat: The latitude
- Lng: The longitude
ContainerYardReference: The reference number for the container yard used in the route (string, nullable)
ContainerVesselName: The name of the vessel used in the route (string, nullable)
ContainerVoyage: The name of the voyage used in the route (string, nullable)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "consignment-route-updated",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "consignmentId": "00000000-0000-0000-0000-000000000002",
    "clientPartnerId": "00000000-0000-0000-0000-000000000003",
    "carrierPartnerId": null,
    "type": 1,
    "status": 4,
    "originAddress": {
      "warehouseId": null,
      "location": {
        "lat": -43.0000000,
        "lng": 172.0000000
      }
    },
    "destinationAddress": {
      "warehouseId": "00000000-0000-0000-0000-000000000004",
      "location": {
        "lat": -43.0000000,
        "lng": 172.00000000
      }
    },
    "carrierName": null,
    "carrierReferenceNumber": null,
    "containerSize": null,
    "containerType": null,
    "containerStatus": null,
    "containerNumber": null,
    "containerReceivedDate": null,
    "containerReturnedDate": null,
    "containerYardAddressId": null,
    "containerYardName": null,
    "containerYardAddressText": null,
    "containerYardLocation": null,
    "containerVesselName": null,
    "containerVoyage": null,
    "containerYardReference": null,
    "originConnectionId": "NQ7ciA_As4KnGfLKxcIaVg"
  },
  "timestamp": 638307626053844238
}

Consignment Metrics Updated

Fires: when a consignment's metric card is updated.
Scoped: to the Client and Carrier selected in the subscription.
Event Type: consignment-metrics-updated

Event:

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)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "consignment-metrics-updated",
  "event": {
    "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",
    "originConnectionId": "LUerlbPQBLNzdf6oIJrZ0g"
  },
  "timestamp": 638306981981916216
}

Consignment Products Updated

Fires: when a consignment's product card is updated.
Scoped: to the Client and Carrier selected in the subscription.
Event Type: consignment-products-updated

Event:

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)
PartnerProductIds: A collection of Product Id's that were affected by the update
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "consignment-products-updated",
  "event": {
    "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",
    "partnerProductIds": null,
    "originConnectionId": "LUerlbPQBLNzdf6oIJrZ0g"
  },
  "timestamp": 638306981981916216
}

Consignment Status Updated

Fires: when a consignment's status is updated.
Scoped: to the Client and Carrier selected in the subscription.
Event Type: consignment-status-updated

Event:

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)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "consignment-status-updated",
  "event": {
    "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,
    "releasedPartnerProductIds": null,
    "originConnectionId": "LUerlbPQBLNzdf6oIJrZ0g"
  },
  "timestamp": 638306982949853078
}

Consignment Import Pending Reconciliation

Fires: when a pending import needs manual reconciliation.
Scoped: to the Client and Carrier selected in the subscription.
Event Type: consignment-import-pending-reconciliation

Event:

OrganisationId: The identifier for your organisation (uuid)
ConsignmentImportId: The identifier of the import (will become the consignmentId when reconciled) (uuid)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "consignment-import-pending-reconciliation",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "consignmentImportId": "00000000-0000-0000-0000-000000000002",
    "originConnectionId": null
  },
  "timestamp": 638307711623603098
}

Consignment Import Reconciled

Fires: when a consignment is created through import reconciliation.
Scoped: to the Client and Carrier selected in the subscription.
Event Type: consignment-import-reconciled

Event:

OrganisationId: The identifier for your organisation (uuid)
ConsignmentImportId: The identifier of the consignment import (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)
OriginAddress: The address of the origin
- WarehouseId: The identifier of the Warehouse if the origin address is a warehouse (uuid, nullable)
- Location: The geocoordinates of the address
  - Lat: The latitude
  - Lng: The longitude
DestinationAddress: The address of the destination
- WarehouseId: The identifier of the Warehouse if the destination address is a warehouse (uuid, nullable)
- Location: The geocoordinates of the address
  - Lat: The latitude
  - Lng: The longitude
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "consignment-import-reconciled",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "consignmentImportId": "00000000-0000-0000-0000-000000000002", 
    "consignmentId": "00000000-0000-0000-0000-000000000002",
    "consignmentNumber": "JWBL-000000-IN",
    "clientPartnerId": "00000000-0000-0000-0000-000000000003",
    "carrierPartnerId": null,
    "type": 1,
    "enteredDate": "2023-01-01T00:00:00+00:00",
    "originAddress": {
      "warehouseId": null,
      "location": {
        "lat": -43.0000000,
        "lng": 172.0000000
      }
    },
    "destinationAddress": {
      "warehouseId": "00000000-0000-0000-0000-000000000004",
      "location": {
        "lat": -43.0000000,
        "lng": 172.0000000
      }
    },
    "originConnectionId": "LUerlbPQBLNzdf6oIJrZ0g"
  },
  "timestamp": 638306981121668077
}

Schedule Created

Fires: when a partner schedule is created.
Scoped: to the Client selected in the subscription.
Event Type: partner-schedule-created

Event:

OrganisationId: The identifier for your organisation (uuid)
PartnerId: The identifier of the Client Partner for this schedule (uuid)
PartnerScheduleId: The identifier of the Client Partner's schedule that triggered the export (uuid)
Date: The date that the schedule was dated for (date/time, no time component, local to the user that entered it)
ReferenceNumber: The reference number of the schedule (string, nullable),
Description: The description of the schedule (string, nullable)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "partner-schedule-created",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "partnerId": "00000000-0000-0000-0000-000000000002",
    "partnerScheduleId": "00000000-0000-0000-0000-000000000003",
    "date": "2023-01-01T00:00:00+00:00",
    "referenceNumber": null,
    "description": null,
    "originConnectionId": "I63PPXQL8OIvx50c48oPpw"
  },
  "timestamp": 638306985379905526
}

Schedule General Updated

Fires: when a partner schedule's general card is updated.
Scoped: to the Client selected in the subscription.
Event Type: partner-schedule-general-updated

Event:

OrganisationId: The identifier for your organisation (uuid)
PartnerId: The identifier of the Client Partner for this schedule (uuid)
PartnerScheduleId: The identifier of the Client Partner's schedule that triggered the export (uuid)
Date: The date that the schedule was dated for (date/time, no time component, local to the user that entered it)
ReferenceNumber: The reference number of the schedule (string, nullable),
Description: The description of the schedule (string, nullable)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "partner-schedule-general-updated",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "partnerId": "00000000-0000-0000-0000-000000000002",
    "partnerScheduleId": "00000000-0000-0000-0000-000000000003",
    "date": "2023-01-01T00:00:00+00:00",
    "referenceNumber": null,
    "description": null,
    "originConnectionId": "I63PPXQL8OIvx50c48oPpw"
  },
  "timestamp": 638306985379905526
}

Schedule Status Update

Fires: when a partner schedule's status is updated.
Scoped: to the Client selected in the subscription.
Event Type: partner-schedule-status-updated

Event:

OrganisationId: The identifier for your organisation (uuid)
PartnerId: The identifier of the Client Partner for this schedule (uuid)
PartnerScheduleId: The identifier of the Client Partner's schedule that triggered the export (uuid)
Status: The current status of the schedule (integer)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "partner-schedule-general-updated",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "partnerId": "00000000-0000-0000-0000-000000000002",
    "partnerScheduleId": "00000000-0000-0000-0000-000000000003",
    "status": 2,
    "originConnectionId": "I63PPXQL8OIvx50c48oPpw"
  },
  "timestamp": 638306985379905526
}

Schedule Removed

Fires: when a partner schedule's is removed.
Scoped: to the Client selected in the subscription.
Event Type: partner-schedule-removed

Event:

OrganisationId: The identifier for your organisation (uuid)
PartnerId: The identifier of the Client Partner for this schedule (uuid)
PartnerScheduleId: The identifier of the Client Partner's schedule that triggered the export (uuid)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "partner-schedule-general-updated",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "partnerId": "00000000-0000-0000-0000-000000000002",
    "partnerScheduleId": "00000000-0000-0000-0000-000000000003",
    "originConnectionId": "I63PPXQL8OIvx50c48oPpw"
  },
  "timestamp": 638306985379905526
}

Job Created

Fires: when a job is created.
Scoped: to the Organisation selected in the subscription.
Event Type: job-created

Event:

OrganisationId: The identifier for your organisation (uuid)
WarehouseId: The identifier of the warehouse this job is attached to (uuid)
JobId: The identifier for the job (uuid)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "job-created",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "warehouseId": "00000000-0000-0000-0000-000000000002",
    "jobId": "00000000-0000-0000-0000-000000000003",
    "originConnectionId": "I63PPXQL8OIvx50c48oPpw"
  },
  "timestamp": 638306985379905526
}

Job Updated

Fires: when a job is updated
Scoped: to the Organisation selected in the subscription.
Event Type: job-updated

Event:

OrganisationId: The identifier for your organisation (uuid)
WarehouseId: The identifier of the warehouse this job is attached to (uuid)
JobId: The identifier for the job (uuid)
consignmentIds: An array of the consignment Ids attached to the job (uuid)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "job-created",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "warehouseId": "00000000-0000-0000-0000-000000000002",
    "jobId": "00000000-0000-0000-0000-000000000003",
    "consignmentIds": [
      "00000000-0000-0000-0000-000000000004",
      "00000000-0000-0000-0000-000000000005"
    ],
    "originConnectionId": "I63PPXQL8OIvx50c48oPpw"
  },
  "timestamp": 638306985379905526
}

Job Status Updated

Fires: when a job's status is updated
Scoped: to the Organisation selected in the subscription.
Event Type: job-status-updated

Event:

OrganisationId: The identifier for your organisation (uuid)
WarehouseId: The identifier of the warehouse this job is attached to (uuid)
JobId: The identifier for the job (uuid)
PreviousStatus: The previous status of the job (integer)
Status: current status of the job (integer)
Type: The type of the job (integer)
OriginConnectionId: An internal connection identifier (string)

{
  "eventType": "job-created",
  "event": {
    "organisationId": "00000000-0000-0000-0000-000000000001",
    "warehouseId": "00000000-0000-0000-0000-000000000002",
    "jobId": "00000000-0000-0000-0000-000000000003",
    "previousStatus": 3,
    "status": 2,
    "type": 1,
    "originConnectionId": "I63PPXQL8OIvx50c48oPpw"
  },
  "timestamp": 638306985379905526
}

How can we help?

Search

Quick Links

Webhook Verification (Optional)

Consignment Events

Schedule Events

Job Events

Webhook Verification (Optional: Direct API-Method)

Payload definitions

Consignment Created

Consignment General Updated

Consignment Route Updated

Consignment Metrics Updated

Consignment Products Updated

Consignment Status Updated

Consignment Import Pending Reconciliation

Consignment Import Reconciled

Schedule Created

Schedule General Updated

Schedule Status Update

Schedule Removed

Job Created

Job Updated

Job Status Updated