Oneprofile Helpscout API

openapi: 3.2.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: REST API reference for Oneprofile, the GTM data layer for your CRM. Manage tables, enrichments, and integrations. Authenticate with an API key to get started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: Reference | Oneprofile Helpscout API
  version: 1.0.42765316646
tags:
- description: Endpoints for the Help Scout support Beacon.
  name: helpscout
paths:
  /helpscout/identity/:
    get:
      description: Sign the user's email address with the Beacon secure-mode key, and return it with the details the support widget fills its form and conversation with.
      operationId: get_helpscout_identity
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HelpScoutIdentitySchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Mint the signed identity the Help Scout Beacon needs
      tags:
      - helpscout
components:
  schemas:
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
      - detail
      title: ForbiddenResponse
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
          - items: {}
            type: array
          - additionalProperties: true
            type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: The type of the error. Useful for frontend code to handle different types of errors.
          title: Type
          type: string
      required:
      - loc
      - msg
      - type
      - input
      title: UnprocessableEntityIssue
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
      - detail
      title: ServerErrorResponse
      type: object
    HelpScoutIdentitySchema:
      description: 'Who the Beacon should say is writing, and the proof that it is them.


        The email is returned rather than read from Clerk in the browser because it

        is the string the signature was computed over: a Beacon handed a different

        address than the one that was signed fails secure mode silently.'
      properties:
        company:
          description: The workspace they are writing from.
          title: Company
          type: string
        email:
          description: The address the signature below was computed over.
          title: Email
          type: string
        name:
          anyOf:
          - type: string
          - type: 'null'
          description: The customer's full name, or null when Clerk holds neither part.
          title: Name
        org_id:
          description: Clerk organization id, for looking the workspace up.
          title: Org Id
          type: string
        role:
          description: Their role in that workspace.
          title: Role
          type: string
        signature:
          description: HMAC-SHA256 hex signature of the email, which Beacon secure mode checks before it trusts the identity the page claims.
          title: Signature
          type: string
        user_id:
          description: Clerk user id, for looking the person up.
          title: User Id
          type: string
      required:
      - email
      - signature
      - name
      - company
      - role
      - user_id
      - org_id
      title: HelpScoutIdentitySchema
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message.
          title: Detail
          type: string
        issues:
          description: The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
      - detail
      - issues
      title: UnprocessableEntityResponse
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
      - detail
      title: UnauthorizedResponse
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http