Skip to main content
WEBHOOK
CARD_SHIPMENT_STATUS_UPDATED
{
  "id": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "destinationAddress": {
      "line1": "<string>",
      "line2": "<string>",
      "zone": "<string>",
      "city": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    },
    "recipient": {
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "dialCode": 123,
      "email": "jsmith@example.com"
    },
    "courier": {
      "name": "<string>"
    },
    "trackingNumber": "<string>",
    "trackingUrl": "<string>",
    "cutoffDate": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "submittedAt": "<string>",
    "deliveredAt": "<string>"
  }
}

Body

application/json
id
string
required

Unique event identifier for idempotency

type
enum<string>
required

Webhook event type

Available options:
CARD_SHIPMENT_STATUS_UPDATED
data
object
required

Response

200

Webhook received successfully. Return any 2xx status to acknowledge.