Skip to navigation

Glossary

View as Markdown
TermMeaning
BrandThe Hive account a token is scoped to. All data read or written is tied to the brand that authorized the token, and is never passed explicitly in requests.
PartnerYour organization, as registered with Hive for API access. Identified by client_id / X-Partner-Id.
Partner PortalSelf-service dashboard (app.hive.co/partners/portal/) for managing OAuth credentials, redirect URIs, and portal admins. See Partner Portal.
ScopeA named permission (for example, orders:write) granted to your OAuth app during authorization, controlling which resources and actions your token can access.
PKCEProof Key for Code Exchange: an OAuth 2.0 extension Hive requires to secure the authorization code flow.
Authorization Code FlowThe OAuth 2.0 flow Hive requires (with PKCE). The Client Credentials Flow isn’t supported.
TierA ticket type or price level within an event (for example, General Admission or VIP).
Static segmentA manually managed list of contacts whose membership can be changed through the API.
Hive API segmentA dynamic segment Hive creates for the brand that contains every contact pushed through the API.
Dynamic segmentA rule-based segment whose membership Hive computes automatically. Its users can’t be added or removed through the API.
Custom propertyA user-defined metadata field. Contacts take free-form string key/value pairs; events use typed, brand-level property definitions managed through dedicated endpoints.
202 AcceptedResponse confirming a write was received and queued, not that processing finished.
Eventually consistentData isn’t visible immediately after a push; it appears once asynchronous processing completes.
stats_refreshed_atTimestamp showing when a campaign’s cached stats were last refreshed (recomputed), not necessarily when they changed. Compare it against your stored value to avoid re-fetching unchanged stats.