Hull Authentication

generated: '2026-07-19'
method: searched
source: https://www.hull.io/docs/reference/http_api/authentication/
summary:
  types: [apiKey, http]
  api_key_in: [header, query]
  oauth2_flows: []
  notes: >-
    Hull authenticates with a Connector ID and a Connector Secret (or a
    user/account-scoped JSON Web Token) passed in custom HTTP headers. There is
    no OAuth2 authorization server and no scope surface; access is scoped by the
    Connector and, for user/account operations, by the claims embedded in the JWT.
schemes:
  - name: HullAppId
    type: apiKey
    in: header
    parameter: Hull-App-Id
    description: The Connector ID, found in any connector settings pane.
    sources: [docs]
  - name: HullAccessToken
    type: apiKey
    in: header
    parameter: Hull-Access-Token
    description: >-
      Either the Connector Secret (server-side) or a user/account-scoped JSON Web
      Token generated by the Hull client. The JWT carries identity claims and is
      how you submit events/attributes "as a user" or "as an account".
    sources: [docs]
  - name: QueryParamAuth
    type: apiKey
    in: query
    parameter: id
    description: >-
      App ID (id) and Access Token (secret) may also be passed as query
      parameters, though Hull strongly discourages it. Never expose the Connector
      Secret on the client side.
    sources: [docs]
jwt:
  header: Hull-Access-Token
  purpose: user/account identity claims (Identity Resolution)
  docs: https://www.hull.io/docs/reference/identity_resolution/
firehose_auth:
  description: >-
    When sending data to the Firehose, a JWT is passed per batch entry in
    headers["Hull-Access-Token"], carrying the claims for that command.
  docs: https://www.hull.io/docs/reference/http_api/authentication/