project44 · Schema

WebhookSubscriptionCreate

LogisticsSupply Chain VisibilityTrackingFreightMulti-modal

Properties

Name Type Description
callbackUrl string HTTPS URL to receive event notifications
eventTypes array Event types to subscribe to
secret string HMAC secret for webhook signature verification
View JSON Schema on GitHub

JSON Schema

project44-webhooksubscriptioncreate-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebhookSubscriptionCreate",
  "title": "WebhookSubscriptionCreate",
  "type": "object",
  "required": [
    "callbackUrl",
    "eventTypes"
  ],
  "properties": {
    "callbackUrl": {
      "type": "string",
      "format": "uri",
      "description": "HTTPS URL to receive event notifications"
    },
    "eventTypes": {
      "type": "array",
      "description": "Event types to subscribe to",
      "items": {
        "type": "string",
        "enum": [
          "SHIPMENT_CREATED",
          "STATUS_UPDATE",
          "POSITION_UPDATE",
          "ETA_CHANGE",
          "EXCEPTION",
          "COMPLETED"
        ]
      }
    },
    "secret": {
      "type": "string",
      "description": "HMAC secret for webhook signature verification"
    }
  }
}