Welcome to the Hive API
Connect your platform with Hive
Sync contacts, orders, and events from your platform with one API.
The Hive API V2 is in beta. Questions or feedback? Email api@hive.co.
Overview
The Hive API lets your platform push contact, order, and event data directly into Hive. Instead of Hive pulling data from your systems, you send it to us, so you control when and what data is synced. You can also read back segments, custom event properties, and campaign reporting.
- Push-based: you send data to Hive when it’s ready.
- Asynchronous: data pushes are acknowledged immediately with
202 Accepted, then processed in the background. - Eventually consistent: data typically appears within minutes (up to 1 hour during beta).
- Brand-scoped: every access token is scoped to a single brand, so you never pass a brand identifier in requests.
Base URL
Get started
Get onboarded
Contact your Hive representative to become an API partner. You’ll receive a welcome email once your Partner Portal access is provisioned.
Sign in to the Partner Portal
Use the Partner Portal to view your client_id, rotate your client
secret, and register your OAuth redirect URIs.
Implement OAuth
Build the OAuth 2.0 Authorization Code Flow with PKCE. See Authentication & Authorization.