Hellou AI Automation Rule API

openapi: 3.2.0
info:
  title: HellouOne Automation Rule 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: Automation Rule
paths:
  /api/v1/accounts/{account_id}/automation_rules:
    parameters:
    - $ref: '#/components/parameters/account_id'
    get:
      tags:
      - Automation Rule
      operationId: get-account-automation-rule
      summary: List all automation rules in an account
      parameters:
      - $ref: '#/components/parameters/account_id'
      - $ref: '#/components/parameters/page'
      description: Get details of automation rules in an Account
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of all automation rules
                items:
                  $ref: '#/components/schemas/automation_rule'
        '403':
          description: Access denied
    post:
      tags:
      - Automation Rule
      operationId: add-new-automation-rule-to-account
      summary: Add a new automation rule
      description: Add a new automation rule to account
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/automation_rule'
        '403':
          description: Access denied
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automation_rule_create_update_payload'
  /api/v1/accounts/{account_id}/automation_rules/{id}:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - name: id
      in: path
      schema:
        type: number
      description: ID of the Automation Rule
      required: true
    get:
      tags:
      - Automation Rule
      operationId: get-details-of-a-single-automation-rule
      summary: Get a automation rule details
      description: Get the details of a automation rule in the account
      parameters:
      - in: path
        name: id
        required: true
        description: The ID of the automation rule to be updated.
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/automation_rule'
        '401':
          description: Unauthorized
        '404':
          description: The given rule ID does not exist in the account
    patch:
      tags:
      - Automation Rule
      operationId: update-automation-rule-in-account
      summary: Update automation rule in Account
      description: Update a automation rule in account
      security:
      - userApiKey: []
      parameters:
      - in: path
        name: id
        required: true
        description: The ID of the automation rule to be updated.
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/automation_rule'
        '403':
          description: Access denied
        '404':
          description: Rule not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automation_rule_create_update_payload'
    delete:
      tags:
      - Automation Rule
      operationId: delete-automation-rule-from-account
      summary: Remove a automation rule from account
      security:
      - userApiKey: []
      parameters:
      - in: path
        name: id
        required: true
        description: The ID of the automation rule to be deleted
        schema:
          type: integer
      responses:
        '200':
          description: Success
        '403':
          description: Access denied
        '404':
          description: automation rule not found
components:
  parameters:
    account_id:
      in: path
      name: account_id
      required: true
      description: The numeric ID of the account
      schema:
        type: integer
    page:
      in: query
      name: page
      required: false
      description: The page parameter
      schema:
        type: integer
        default: 1
  schemas:
    automation_rule:
      type: object
      properties:
        event_name:
          type: string
          description: Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)
          enum:
          - conversation_created
          - conversation_updated
          - message_created
          example: message_created
        name:
          type: string
          description: The name of the rule
          example: Add label on message create event
        description:
          type: string
          description: Description to give more context about the rule
          example: Add label support and sales on message create event if incoming message content contains text help
        active:
          type: boolean
          description: Enable/disable automation rule
        actions:
          type: array
          description: Array of actions which we perform when condition matches
          items:
            type: object
            example:
              action_name: add_label
              action_params:
              - support
              - sales
        conditions:
          type: array
          description: Array of conditions on which conversation/message filter would work
          items:
            type: object
            example:
              attribute_key: content
              filter_operator: contains
              values:
              - help
              query_operator: nil
        account_id:
          type: integer
          description: Account Id
    automation_rule_create_update_payload:
      type: object
      properties:
        name:
          type: string
          description: Rule name
          example: Add label on message create event
        description:
          type: string
          description: The description about the automation and actions
          example: Add label support and sales on message create event if incoming message content contains text help
        event_name:
          type: string
          enum:
          - conversation_created
          - conversation_updated
          - message_created
          example: message_created
          description: The event when you want to execute the automation actions
        active:
          type: boolean
          description: Enable/disable automation rule
        actions:
          type: array
          description: Array of actions which you want to perform when condition matches, e.g add label support if message contains content help.
          items:
            type: object
            example:
              action_name: add_label
              action_params:
              - support
        conditions:
          type: array
          description: Array of conditions on which conversation filter would work, e.g message content contains text help.
          items:
            type: object
            example:
              attribute_key: content
              filter_operator: contains
              query_operator: nil
              values:
              - help
  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