Quickstart | Hive API | Documentation

This guide walks you through the minimum steps to send data to Hive. Orders reference an event by event_id, so push the event first.

Get your API credentials

Once onboarded, sign in to the Partner Portal to get your client_id and client secret, and register at least one redirect URI.

Set up a test brand

A sandbox environment is coming soon. In the meantime, ask your Hive contact (or api@hive.co) to set up a dedicated test brand for your integration testing.

Get an access token

Implement the OAuth 2.0 Authorization Code Flow with PKCE and authorize your app against the test brand. See Authentication & Authorization.

Send your first event

curl -X POST https://api.hive.co/v2/events/ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Partner-Id: $CLIENT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      {
        "event_id": "evt_45678",
        "name": "Summer Music Festival 2026",
        "event_url": "https://example.com/events/summer-fest",
        "start_at": "2026-07-15T18:00:00Z",
        "updated_at": "2026-02-10T12:00:00Z"
      }
    ]
  }'

A 202 Accepted response means the event was received and queued. See Events for all fields.

Event processing is asynchronous. Wait for the event to be processed before pushing orders that reference it; otherwise the order request fails with 422 and “No event exists with event_id …”.

Send your first order

curl -X POST https://api.hive.co/v2/orders/ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Partner-Id: $CLIENT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "orders": [
      {
        "order_id": "ord_98765",
        "event_id": "evt_45678",
        "status": "completed",
        "user": { "email": "jamie@example.com" },
        "items": [
          { "item_id": "item_001", "price": 45.0, "quantity": 2 }
        ],
        "created_at": "2026-02-01T09:55:00Z",
        "updated_at": "2026-02-01T10:00:00Z"
      }
    ]
  }'

See Orders for all fields.

Verify the data in Hive

Sign in to Hive and check the test brand for your event, order, and contact. Allow up to 1 hour for processing during beta.

Checklist

Receive your API credentials from Hive
Implement the OAuth 2.0 Authorization Code Flow with PKCE
Set up a test brand with your Hive contact
Send your first POST /events/ request
Send your first POST /orders/ request
Verify the data appears in Hive (allow up to 1 hour during beta)