GVMS Declaration Status Changed

Developing

Webhook

POST

Sent when the status of one of your GVMS goods movement records changes.

Request

Header Params

Body Params application/json

Example

{
  "webhookId": 12,
  "eventName": "gvms_declarations/status_changed",
  "deliveryId": "c7d3a1e9-5b28-4f6c-9e04-1a8b3d7c5f92",
  "eventKey": "3a9f5c1e-7d2b-5f4a-b8c6-2e0d9a4f7c31",
  "sentAt": "2026-10-09T10:42:17Z",
  "recordType": "gvms_declarations",
  "previousStatus": "sent",
  "status": "OPEN",
  "data": [
    {
      "transaction_id": 600321,
      "transaction_reference": "GVM2610000321",
      "status": "OPEN",
      "error_msg": null,
      "gmr": "GMRA0012ABC3",
      "direction": "UK_OUTBOUND",
      "originPortCode": "GBDVR",
      "destinationPortCode": "FRCQF",
      "ferryOperatorCode": "DFDS",
      "docDate": "2026-10-09",
      "vehicleCode": "AB12CDE",
      "trailerCode": "TR12345",
      "trailer2Code": null,
      "containerNo": null,
      "container2No": null,
      "contractType": "rented",
      "accompanying": true,
      "hasGoods": true,
      "masterDeclaration": null,
      "traderRef": "SHP-2026-0321",
      "notificationEmail": "ops@example.com",
      "notifiedTel": null,
      "customerId": 104512,
      "declarations": [
        {
          "docType": "EXPORT",
          "docNo": "6GB123456789000-SHP20260321",
          "masterRef": "26GB0000000032112"
        }
      ]
    }
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://your-api-server.com' \
--header 'X-Modaltrans-Signature: sha256=d55e674078099a696aebbcb1c4e0094a938fd7902667c8d06de366bcdfcc2741' \
--header 'X-Modaltrans-Delivery: c7d3a1e9-5b28-4f6c-9e04-1a8b3d7c5f92' \
--header 'X-Modaltrans-Event: gvms_declarations/status_changed' \
--header 'User-Agent: Modaltrans-Webhook/1.0' \
--header 'X-Api-Key: 3f9c1ab24e7d05b6c8fa1d3e9b470a52' \
--header 'Content-Type: application/json' \
--data-raw '{
  "webhookId": 12,
  "eventName": "gvms_declarations/status_changed",
  "deliveryId": "c7d3a1e9-5b28-4f6c-9e04-1a8b3d7c5f92",
  "eventKey": "3a9f5c1e-7d2b-5f4a-b8c6-2e0d9a4f7c31",
  "sentAt": "2026-10-09T10:42:17Z",
  "recordType": "gvms_declarations",
  "previousStatus": "sent",
  "status": "OPEN",
  "data": [
    {
      "transaction_id": 600321,
      "transaction_reference": "GVM2610000321",
      "status": "OPEN",
      "error_msg": null,
      "gmr": "GMRA0012ABC3",
      "direction": "UK_OUTBOUND",
      "originPortCode": "GBDVR",
      "destinationPortCode": "FRCQF",
      "ferryOperatorCode": "DFDS",
      "docDate": "2026-10-09",
      "vehicleCode": "AB12CDE",
      "trailerCode": "TR12345",
      "trailer2Code": null,
      "containerNo": null,
      "container2No": null,
      "contractType": "rented",
      "accompanying": true,
      "hasGoods": true,
      "masterDeclaration": null,
      "traderRef": "SHP-2026-0321",
      "notificationEmail": "ops@example.com",
      "notifiedTel": null,
      "customerId": 104512,
      "declarations": [
        {
          "docType": "EXPORT",
          "docNo": "6GB123456789000-SHP20260321",
          "masterRef": "26GB0000000032112"
        }
      ]
    }
  ]
}'

Responses

🟢204Accepted

Return any 2xx once you have stored the body. Process it afterwards. A 5xx, 408 or 429, a timeout after 10 seconds or a connection failure is retried once after 5 minutes. Any other status, including redirects, is not retried.

This response does not have a body.

Modified at 2026-10-09 10:51:10

ENS Declaration Status Changed