# Flexport Webhooks

## When to Use This Skill

* Setting up Flexport webhook handlers
* Debugging Flexport signature verification failures (`X-Hub-Signature-256`)
* Understanding Flexport Event objects and milestone identifiers
* Handling shipment, shipment leg, container, document, invoice, and purchase order events

## Verification (core)

Flexport signs the raw request body with HMAC keyed on your per-endpoint
secret token and sends two GitHub/X-Hub-style headers, each a hex digest
prefixed with the algorithm:

* `X-Hub-Signature-256` — HMAC-SHA256, formatted `sha256=<hex>` (use this)
* `X-Hub-Signature` — HMAC-SHA1, formatted `sha1=<hex>` (legacy, being deprecated)

Verify against the raw UTF-8 body before parsing JSON, and compare timing-safe.

Node:

```javascript
const crypto = require('crypto');

function verify(rawBody, signatureHeader, secret) {
  const [algo, sig] = (signatureHeader || '').split('=');
  if (algo !== 'sha256' || !sig) return false;
  const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
  try {
    return crypto.timingSafeEqual(Buffer.from(sig, 'hex'), Buffer.from(expected, 'hex'));
  } catch {
    return false;
  }
}

```

Python:

```python
import hmac, hashlib

def verify(raw_body: bytes, signature_header: str, secret: str) -> bool:
    algo, _, sig = (signature_header or "").partition("=")
    if algo != "sha256" or not sig:
        return False
    expected = hmac.new(secret.encode(), raw_body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(sig, expected)

```

There is no official Flexport SDK, so verify manually in every framework.

> For complete handlers with route wiring, event dispatch, and tests, see:
> 
> * [examples/express/](https://github.com/hookdeck/webhook-skills/tree/main/skills/flexport-webhooks/examples/express/)
> * [examples/nextjs/](https://github.com/hookdeck/webhook-skills/tree/main/skills/flexport-webhooks/examples/nextjs/)
> * [examples/fastapi/](https://github.com/hookdeck/webhook-skills/tree/main/skills/flexport-webhooks/examples/fastapi/)

## Event Object & Dispatch

The delivered payload is a Flexport Event object. Dispatch on the `type`
field, which holds the milestone identifier in `/object#event` format (note:
`/object#event`, not `object.event`). The affected object is under `data`.

```json
{
  "_object": "/event",
  "id": 123456,
  "version": 2,
  "created_at": "2026-07-23T10:00:00Z",
  "occurred_at": "2026-07-23T09:59:00Z",
  "type": "/shipment#created",
  "data": { "resource": { "...": "..." }, "shipment": { "...": "..." } }
}

```

## Common Event Types

> Only `/shipment#created` and `/shipment_leg#departed` are confirmed against
> Flexport's milestone reference. The other rows below are illustrative
> examples of the `/object#event` format — verify the exact identifiers against
> [Flexport's milestone reference](https://apidocs.flexport.com/v2/tag/Webhook-Endpoints/)
> (or the events your account actually receives) before relying on them.

| Event (`type`) | Triggered When |
| --- | --- |
| `/shipment#created` | A shipment is created (quote confirmed) |
| `/shipment#booking_confirmed` | Carrier booking is confirmed |
| `/shipment#delivered_in_full` | Entire shipment is delivered |
| `/shipment_leg#departed` | A shipment leg departs its origin |
| `/shipment_leg#arrived` | A shipment leg arrives at its destination |
| `/document#document_created` | A document is uploaded/generated |
| `/invoice#invoice_payment_made` | An invoice payment is processed |
| `/purchase_order#acknowledged` | A purchase order is acknowledged |

> For the full milestone reference, see [Flexport Webhook Endpoints](https://apidocs.flexport.com/v2/tag/Webhook-Endpoints/). Some milestones are "available upon request".

## Important Headers

| Header | Description |
| --- | --- |
| `X-Hub-Signature-256` | HMAC-SHA256 signature, `sha256=<hex>` (use this) |
| `X-Hub-Signature` | HMAC-SHA1 signature, `sha1=<hex>` (legacy, deprecated) |

## Environment Variables

```bash
FLEXPORT_WEBHOOK_SECRET=your_secret_token   # Per-endpoint secret token set in Flexport account Settings

```

## Local Development

```bash
# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 flexport --path /webhooks/flexport

```

## Reference Materials

* [references/overview.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/flexport-webhooks/references/overview.md) - Flexport webhook concepts and events
* [references/setup.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/flexport-webhooks/references/setup.md) - Configure endpoints and secret token in Settings
* [references/verification.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/flexport-webhooks/references/verification.md) - Signature verification details and gotchas