Hellou AI Integrations API

openapi: 3.2.0
info:
  title: HellouOne Integrations API
  version: 1.0.0
  description: 'The HellouOne REST API: everything the dashboard does, available to your

    own systems — CRMs, bots, BI tools and back-office automation.'
  termsOfService: https://hellou.ai/en/legal/terms/
  contact:
    name: HellouOne support
    email: support@hellou.ai
servers:
- url: https://one.hellou.ai
  description: HellouOne cloud
security:
- userApiKey: []
tags:
- name: Integrations
paths:
  /api/v1/accounts/{account_id}/integrations/apps:
    parameters:
    - $ref: '#/components/parameters/account_id'
    get:
      tags:
      - Integrations
      operationId: get-details-of-all-integrations
      summary: List all the Integrations
      description: 'Get the details of all Integrations available for the account


        **Requires feature:** `integrations`'
      x-required-feature: integrations
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of Integration apps
                items:
                  $ref: '#/components/schemas/integrations_app'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: Url not found
  /api/v1/accounts/{account_id}/integrations/hooks:
    post:
      tags:
      - Integrations
      operationId: create-an-integration-hook
      summary: Create an integration hook
      description: 'Create an integration hook


        **Requires feature:** `integrations`'
      x-required-feature: integrations
      parameters:
      - $ref: '#/components/parameters/account_id'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrations_hook'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/integrations_hook_create_payload'
  /api/v1/accounts/{account_id}/integrations/hooks/{hook_id}:
    patch:
      tags:
      - Integrations
      operationId: update-an-integrations-hook
      summary: Update an Integration Hook
      description: 'Update an Integration Hook


        **Requires feature:** `integrations`'
      x-required-feature: integrations
      parameters:
      - $ref: '#/components/parameters/account_id'
      - $ref: '#/components/parameters/hook_id'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrations_hook'
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/integrations_hook_update_payload'
    delete:
      tags:
      - Integrations
      operationId: delete-an-integration-hook
      summary: Delete an Integration Hook
      description: 'Delete an Integration Hook


        **Requires feature:** `integrations`'
      x-required-feature: integrations
      parameters:
      - $ref: '#/components/parameters/account_id'
      - $ref: '#/components/parameters/hook_id'
      responses:
        '200':
          description: Success
        '401':
          description: Unauthorized
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          description: The hook does not exist in the account
components:
  schemas:
    integrations_hook:
      type: object
      properties:
        id:
          type: string
          description: The ID of the integration hook
        app_id:
          type: string
          description: The ID of the integration app
        inbox_id:
          type: string
          description: Inbox ID if its an Inbox integration
        account_id:
          type: string
          description: Account ID of the integration
        status:
          type: boolean
          description: Whether the integration hook is enabled for the account
        hook_type:
          type: boolean
          description: Whether its an account or inbox integration hook
        settings:
          type: object
          description: The associated settings for the integration
    integrations_hook_update_payload:
      type: object
      properties:
        settings:
          type: object
          description: The settings required by the integration
    error_message:
      type: object
      description: An error with a human-readable message.
      properties:
        error:
          type: string
          description: What went wrong.
        reason:
          type: string
          description: Machine-readable cause, when there is one (for example `feature_disabled`).
      required:
      - error
    integrations_app:
      type: object
      properties:
        id:
          type: string
          description: The ID of the integration
        name:
          type: string
          description: The name of the integration
        description:
          type: string
          description: The description about the team
        hook_type:
          type: string
          description: Whether the integration is an account or inbox integration
        enabled:
          type: boolean
          description: Whether the integration is enabled for the account
        allow_multiple_hooks:
          type: boolean
          description: Whether multiple hooks can be created for the integration
        hooks:
          type: array
          items:
            type: object
          description: If there are any hooks created for this integration
    integrations_hook_create_payload:
      type: object
      properties:
        app_id:
          type: string
          description: The ID of app for which integration hook is being created
        inbox_id:
          type: string
          description: The inbox ID, if the hook is an inbox hook
        settings:
          type: object
          description: The settings required by the integration
  responses:
    forbidden:
      description: 'Not allowed: the user''s role does not permit it, the feature is not enabled

        for the account (`reason: feature_disabled`), or the account is read-only.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_message'
  parameters:
    account_id:
      in: path
      name: account_id
      required: true
      description: The numeric ID of the account
      schema:
        type: integer
    hook_id:
      in: path
      name: hook_id
      required: true
      description: The numeric ID of the integration hook
      schema:
        type: integer
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A user''s access token, from **Profile settings → Access token** in the dashboard.

        Requests act with that user''s role: administrators reach everything in their

        account, agents only what their role and visibility settings allow.

        '
    agentBotApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'An agent bot''s access token, shown to administrators on the bot''s settings page.

        Bot tokens reach a limited set of conversation and message endpoints.

        '
    platformAppApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A platform app token, issued by the installation operator. Used to provision

        accounts, users, account memberships and agent bots.

        '
    connectorInvokeToken:
      type: http
      scheme: bearer
      description: 'A connector''s invoke token (`hci_…`), sent as `Authorization: Bearer <token>`.

        Each connector install has its own; it is rotated whenever the connector is

        reconnected or disconnected, so a stale copy stops working.

        '
x-tagGroups:
- name: Guides
  tags:
  - Introduction
  - Authentication
  - Errors
  - Pagination
  - Rate limits
  - Webhook events
- name: Webhook payloads
  tags:
  - Event payloads
- name: Platform
  tags:
  - Accounts
  - Account Users
  - AgentBots
  - Users
- name: Application
  tags:
  - Account AgentBots
  - Agents
  - Automation Rule
  - Campaigns
  - Canned Responses
  - Contacts
  - Contact Labels
  - Conversation Assignment
  - Conversation Labels
  - Conversations
  - Custom Attributes
  - Custom Filters
  - Help Center
  - Inboxes
  - Integrations
  - Macros
  - Messages
  - Profile
  - Reports
  - Security Settings
  - Teams
  - Webhooks
- name: Business tools
  tags:
  - AI Classifications
  - Assignment Settings
  - Calls
  - AI Phone Lines
  - Connectors
  - ElevenLabs Integration
  - Facebook Marketing
  - HellouAI Integration
  - Knowledge Base
  - Marketing Consent
  - Plan Upgrades
  - Voice Campaigns
  - WhatsApp Campaigns
  - WhatsApp Flows
  - WhatsApp Templates
- name: Client
  tags:
  - Inbox API
  - Contacts API
  - Conversations API
  - Messages API
- name: Others
  tags:
  - CSAT Survey Page