Happyrobot

Happyrobot Integrations API

The Integrations API from Happyrobot — 4 operation(s) for integrations.

GitHub OpenAPI

Operations 4

GET /integrations/ List integrations
GET /integrations/categories List integration categories with providers
GET /integrations/{integrationId} Get an integration
POST /integrations/{integrationId}/create-credential Create a credential for an integration

Documentation

📖
Documentation
https://docs.happyrobot.ai/api-reference
📖
APIReference
https://docs.happyrobot.ai/api-reference
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/authentication/happyrobot-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/openapi/happyrobot-integrations-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/conventions/happyrobot-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/errors/happyrobot-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/data-model/happyrobot-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/asyncapi/happyrobot-events.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/agentic-access/happyrobot-agentic-access.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/lifecycle/happyrobot-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/happyrobot-integrations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

happyrobot-integrations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Happyrobot Public Integrations API
  description: Public API endpoints for Happyrobot
  version: 0.1.1
servers:
- url: https://platform.happyrobot.ai/api/v2
security:
- bearerAuth: []
tags:
- name: Integrations
paths:
  /integrations/:
    get:
      summary: List integrations
      tags:
      - Integrations
      description: 'Returns available integrations with optional events and credentials. Delegated providers (CRM, HRIS, ATS, etc.) are expanded into individual entries. Supports filtering by category, provider, and search. Paginated (default: 20 per page).'
      parameters:
      - schema:
          type: string
        in: query
        name: search
        required: false
      - schema:
          type: string
        in: query
        name: category
        required: false
        description: Filter by category. Works for both internal groups (e.g. 'Communications', 'Data') and delegated categories (e.g. 'crm', 'hris', 'ats'). Case-insensitive.
      - schema:
          type: string
        in: query
        name: provider
        required: false
        description: Filter by provider slug. Works for both internal integrations (e.g. 'gmail', 'slack') and delegated providers (e.g. 'hubspot', 'workday').
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
        in: query
        name: include_events
        required: false
        description: 'If true, include events per integration (default: false)'
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
        in: query
        name: include_credentials
        required: false
        description: 'If true, include the organization''s connected credentials per integration (default: false)'
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
        in: query
        name: include_config_schema
        required: false
        description: 'If true, include config_schema per event. Only effective when include_events=true (default: false)'
      - schema:
          default: 1
          type: integer
          minimum: 1
          maximum: 9007199254740991
        in: query
        name: page
        required: false
      - schema:
          default: 20
          type: integer
          minimum: 1
          maximum: 100
        in: query
        name: page_size
        required: false
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        group:
                          type: string
                        icon:
                          type: string
                        description:
                          type: string
                        docs_url:
                          type: string
                        website_url:
                          type: string
                        is_top:
                          type: boolean
                        requires_credentials:
                          type: boolean
                        agent_specific:
                          type: boolean
                        events:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                                pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                              name:
                                type: string
                              integration_id:
                                type: string
                                format: uuid
                                pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                              type:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                                description: 0 = trigger, 1 = action
                              description:
                                type: string
                              is_instant:
                                type: boolean
                              has_cron_trigger:
                                type: boolean
                              coming_soon:
                                type: boolean
                              config_schema:
                                type:
                                - array
                                - 'null'
                                items:
                                  $ref: '#/components/schemas/schema0'
                              delegated_category:
                                description: Non-null for delegated provider events (e.g. 'crm', 'hris'). When present, the node configuration must include _merge_provider_slug.
                                type:
                                - string
                                - 'null'
                            required:
                            - id
                            - name
                            - integration_id
                            - type
                            - description
                            - is_instant
                            - has_cron_trigger
                            - coming_soon
                            additionalProperties: false
                        credentials:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                                pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                              integration_id:
                                type: string
                                format: uuid
                                pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                              title:
                                type: string
                              timestamp:
                                type: string
                            required:
                            - id
                            - integration_id
                            - title
                            - timestamp
                            additionalProperties: false
                        credential_config:
                          type:
                          - object
                          - 'null'
                          properties:
                            credential_types:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                  display_name:
                                    type: string
                                  description:
                                    type: string
                                  flow:
                                    type: string
                                    enum:
                                    - oauth
                                    - form
                                  fields:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                        label:
                                          type: string
                                        type:
                                          type: string
                                          enum:
                                          - string
                                          - password
                                          - email
                                          - number
                                          - boolean
                                          - select
                                        required:
                                          type: boolean
                                        description:
                                          type: string
                                        options:
                                          type: array
                                          items:
                                            type: string
                                      required:
                                      - name
                                      - label
                                      - type
                                      - required
                                      additionalProperties: false
                                required:
                                - type
                                - display_name
                                - description
                                - flow
                                - fields
                                additionalProperties: false
                            default_credential_type:
                              type: string
                          required:
                          - credential_types
                          - default_credential_type
                          additionalProperties: false
                      required:
                      - id
                      - name
                      - group
                      - icon
                      - description
                      - docs_url
                      - website_url
                      - is_top
                      - requires_credentials
                      - agent_specific
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page:
                        type: number
                      page_size:
                        type: number
                      total_pages:
                        type: number
                      total_records:
                        type: number
                      has_next_page:
                        type: boolean
                      has_previous_page:
                        type: boolean
                    required:
                    - page
                    - page_size
                    - total_pages
                    - total_records
                    - has_next_page
                    - has_previous_page
                    additionalProperties: false
                required:
                - data
                - pagination
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
  /integrations/categories:
    get:
      summary: List integration categories with providers
      tags:
      - Integrations
      description: Returns a unified map of categories to their available providers. Includes both internal integration groups (Communications, Data, etc.) and delegated provider categories (CRM, HRIS, ATS, etc.).
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          slug:
                            type: string
                          icon:
                            type:
                            - string
                            - 'null'
                        required:
                        - id
                        - name
                        - slug
                        - icon
                        additionalProperties: false
                required:
                - data
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
  /integrations/{integrationId}:
    get:
      summary: Get an integration
      tags:
      - Integrations
      description: Returns a single integration by ID, including its events and the organization's connected credentials. Supports both native integration UUIDs and delegated provider composite IDs (e.g. {uuid}--{provider_slug}).
      parameters:
      - schema:
          type: string
        in: path
        name: integrationId
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  group:
                    type: string
                  icon:
                    type: string
                  description:
                    type: string
                  docs_url:
                    type: string
                  website_url:
                    type: string
                  is_top:
                    type: boolean
                  requires_credentials:
                    type: boolean
                  agent_specific:
                    type: boolean
                  events:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                        name:
                          type: string
                        integration_id:
                          type: string
                          format: uuid
                          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                        type:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: 0 = trigger, 1 = action
                        description:
                          type: string
                        is_instant:
                          type: boolean
                        has_cron_trigger:
                          type: boolean
                        coming_soon:
                          type: boolean
                        config_schema:
                          type:
                          - array
                          - 'null'
                          items:
                            $ref: '#/components/schemas/schema0'
                        delegated_category:
                          description: Non-null for delegated provider events (e.g. 'crm', 'hris'). When present, the node configuration must include _merge_provider_slug.
                          type:
                          - string
                          - 'null'
                      required:
                      - id
                      - name
                      - integration_id
                      - type
                      - description
                      - is_instant
                      - has_cron_trigger
                      - coming_soon
                      additionalProperties: false
                  credentials:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        integration_id:
                          type: string
                          format: uuid
                          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                        title:
                          type: string
                        timestamp:
                          type: string
                      required:
                      - id
                      - integration_id
                      - title
                      - timestamp
                      additionalProperties: false
                  credential_config:
                    type:
                    - object
                    - 'null'
                    properties:
                      credential_types:
                        type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                            display_name:
                              type: string
                            description:
                              type: string
                            flow:
                              type: string
                              enum:
                              - oauth
                              - form
                            fields:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  label:
                                    type: string
                                  type:
                                    type: string
                                    enum:
                                    - string
                                    - password
                                    - email
                                    - number
                                    - boolean
                                    - select
                                  required:
                                    type: boolean
                                  description:
                                    type: string
                                  options:
                                    type: array
                                    items:
                                      type: string
                                required:
                                - name
                                - label
                                - type
                                - required
                                additionalProperties: false
                          required:
                          - type
                          - display_name
                          - description
                          - flow
                          - fields
                          additionalProperties: false
                      default_credential_type:
                        type: string
                    required:
                    - credential_types
                    - default_credential_type
                    additionalProperties: false
                required:
                - id
                - name
                - group
                - icon
                - description
                - docs_url
                - website_url
                - is_top
                - requires_credentials
                - agent_specific
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
  /integrations/{integrationId}/create-credential:
    post:
      summary: Create a credential for an integration
      tags:
      - Integrations
      description: Creates a new credential for a form-based integration. OAuth integrations are not supported via API — use the HappyRobot platform UI instead.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                credential_type:
                  type: string
                title:
                  type: string
                data:
                  type: object
                  additionalProperties: {}
              required:
              - title
              - data
        required: true
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
        in: path
        name: integrationId
        required: true
      security:
      - bearerAuth: []
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  integration_id:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                  title:
                    type: string
                  timestamp:
                    type: string
                required:
                - id
                - integration_id
                - title
                - timestamp
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '405':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque