Webhook Payloads

order.created

Triggered when an order is created on FleetRunnr.


order.updated

Triggered when an order is updated on FleetRunnr.


order.cancelled

Triggered when an order is cancelled on FleetRunnr.


customer.created

Triggered when a customer is created on FleetRunnr.


customer.updated

Triggered when a customer is updated on FleetRunnr.


// order.created
{
  "topic": "order.created"
  "data": [
      "order_uuid": "0921b03f-90db-4a47-8077-d772a6114084",
      "order_number": "489611269028970496",
      "external_id": "XYZ2",
      "tracking_url": "https:\/\/track.fleetrunnr.test\/494760662157754368?s=9438e2fb4d024905b82360f25ee06a16"
  ]
}

// order.updated
{
  "topic": "order.updated"
  "data": [
      "order": {
        "uuid": "ccbba558-8d10-46c1-a74f-46664b4c6eaf",
        "order_number": "494760662157754368",
        "external_id": "XYZ2"
        "tracking_url": "https:\/\/track.fleetrunnr.test\/494760662157754368?s=9438e2fb4d024905b82360f25ee06a16",
        "status": "SHIPPED",
        "carrier": {
          "uuid": "d06d19e8-f055-45ff-8435-a0699e5f7dc7",
          "name": "carrier1",
          "agent": "agent1",
          "shipping_method": {
            "name": "Standard",
            "currency": "LBP",
            "base_fee": 3
          },
          "fees": [
            {
              "type": "SHIPPING_FEE",
              "currency": "USD",
              "amount": 5
            }
          ]
        },
        "customer": {
          "id": 1,
          "uuid": "37c806cf-dd5d-42ca-b6b3-c4d4133aad00",
          "external_id": null,
          "name": "john kendrick",
          "email": "john@hotmail.com",
          "phone": null,
          "avatar": "https:\/\/www.gravatar.com\/avatar\/0640ce31a94cdb8744cc5a956129f611?d=404"
        },
        "source_location": {
          "id": 2,
          "external_id": null,
          "name": "main",
          "line_1": "Kj Beirut",
          "line_2": null,
          "city": "Beirut",
          "region": "Beirut",
          "country": "LB",
          "coordinates": {
            "lat": 33.8984,
            "lng": 35.50673
          },
          "zip_code": null,
          "directions": null,
          "verified_at": null,
          "can_edit": false
        },
        "source_contact": {
          "uuid": "494760662157754368",
          "name": "carrier1",
          "phone": null,
          "email": null
        },
        "destination_location": {
          "id": 1,
          "external_id": null,
          "name": "destination",
          "line_1": "Hjar Baalback",
          "line_2": null,
          "city": "Baalbek",
          "region": "Baalbek Hermel",
          "country": "LB",
          "coordinates": {
            "lat": 34,
            "lng": 36.2
          },
          "zip_code": null,
          "directions": null,
          "verified_at": null,
          "can_edit": false
        },
        "destination_contact": {
          "uuid": "494760662157754368",
          "name": "john kendrick",
          "phone": null,
          "email": "john@hotmail.com"
        },
        "proof_of_delivery": {
          "image": {
            "required": false,
            "url": null
          },
          "signature": {
            "required": false,
            "url": null
          }
        },
        "packages": [
          {
            "uuid": "236d2298-54a1-4510-a9be-d51252397a8c",
            "barcode": "494760662258417664",
            "type": "PARCEL",
            "length": 4,
            "width": 4,
            "height": 4,
            "length_unit": "cm"
          }
        ],
        "collections": [
          {
            "uuid": "329873f8-8857-46e2-b93d-7f76cd0416a3",
            "type": "CASH",
            "amount": 120.75,
            "currency": "USD",
            "amount_formatted": "$120.75",
            "is_prepayment": false
          }
        ],
        "is_return": false,
        "notes": "notes here..."
        "created_at": "2023-05-04T14:50:22.000000Z"
      }
  ]
}

// order.cancelled
{
  "topic": "order.cancelled"
  "data": [
      "order_uuid": "0921b03f-90db-4a47-8077-d772a6114084",
      "order_number": "489611269028970496",
      "external_id": "XYZ5"
  ]
}

// customer.created
{
  "topic": "customer.created"
  "data": [
      "customer": {
        "id": 12
        "uuid": "68f1f1ed-48ad-4d8d-9524-556eb621e9fe"
        "first_name": "John"
        "last_name": "Kendrick"
        "name": "John Kendrick"
        "phone": "+1-202-555-0103"
        "type": "INDIVIDUAL"
        "created_at": "2023-05-22T11:20:40.000000Z" 
      }
  ]
}

// customer.updated
{
  "topic": "customer.updated"
  "data": [
      "customer": {
        "id": 12
        "uuid": "68f1f1ed-48ad-4d8d-9524-556eb621e9fe"
        "first_name": "John"
        "last_name": "Kendrick Updated"
        "name": "John Kendrick Updated"
        "phone": "+1-202-555-0103"
        "type": "INDIVIDUAL"
        "created_at": "2023-05-22T11:20:40.000000Z" 
      }
  ]
}