Webhook Endpoints

Webhook endpoint registration is available in v1. Delivery, signatures, and retries are still being finalized (see Webhooks in the sidebar).

Create Webhook Endpoint

POST /public/v1/webhook-endpoints

Headers:

• X-Public-API-Key: <key> (or Authorization: Bearer <token>)
• Idempotency-Key: <uuid>

Body:

{
  "url": "https://example.com/webhooks/fieldkit",
  "event_types": ["order.status.changed", "shipment.delivered"],
  "enabled": true
}

Notes:

• url must be http or https.
• event_types is optional. If omitted, the endpoint is created with an empty subscription set.
• The response includes a secret which is only returned on create (store it securely).

Example:

curl -sS \
  -X POST \
  -H "X-Public-API-Key: $FIELDKIT_PUBLIC_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/webhooks/fieldkit","event_types":["order.status.changed"],"enabled":true}' \
  "https://api.fieldkit.cc/public/v1/webhook-endpoints"

Response:

{
  "id": "d48e0b2a-7b1e-4b74-bcf4-9e23d4a51c0f",
  "url": "https://example.com/webhooks/fieldkit",
  "enabled": true,
  "event_types": ["order.status.changed"],
  "secret": "whsec_...",
  "created_at": "2026-02-09T19:12:34.567Z"
}

List Webhook Endpoints

GET /public/v1/webhook-endpoints

curl -sS \
  -H "X-Public-API-Key: $FIELDKIT_PUBLIC_API_KEY" \
  "https://api.fieldkit.cc/public/v1/webhook-endpoints"

Response:

{
  "items": [
    {
      "id": "d48e0b2a-7b1e-4b74-bcf4-9e23d4a51c0f",
      "url": "https://example.com/webhooks/fieldkit",
      "enabled": true,
      "event_types": ["order.status.changed"],
      "created_at": "2026-02-09T19:12:34.567Z"
    }
  ]
}