openapi: 3.1.0
info:
  title: Helpcenter Workflow Configurations API
  version: 1.0.0
tags:
- name: Workflow Configurations
paths:
  /workflow_configurations:
    get:
      summary: To get workflow configuration metadata
      description: To retrieve the complete configuration metadata details for workflows.This includes the list of available triggers for the module, the actions supported for each trigger, and their limits and properties. 
      operationId: getWorkflowConfigurations
      parameters:
      - $ref: '#/components/parameters/ParamQueryModule'
      responses:
        '200':
          description: Indicates that the workflow configuration was retrieved successfully for the specified module.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetworkflowconfigurationsResponse200'
        '400':
          description: Invalid module given
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/RequiredParamMissingError'
                - $ref: '#/components/schemas/InvalidModuleResponse'
      security:
      - iam-oauth2-schema:
        - ZohoCRM.settings.workflow_rules.READ
      tags:
      - Workflow Configurations
components:
  parameters:
    ParamQueryModule:
      name: module
      in: query
      description: Specify the API name of the module whose workflow configuration metadata you want to retrieve.
      required: true
      schema:
        type: string
        enum:
        - Leads
  schemas:
    TriggersNested:
      type: object
      additionalProperties: false
      description: Nested schema for triggers
      properties:
        api_name:
          type: string
          description: 'Field: api_name'
          maxLength: 255
        deprecated:
          type: boolean
          description: 'Field: deprecated'
        name:
          type: string
          description: 'Field: name'
          maxLength: 255
        scheduled_actions_supported:
          type: boolean
          description: 'Field: scheduled_actions_supported'
        actions:
          type: array
          description: 'Field: actions'
          items:
            type: string
            description: 'Field: actions'
            maxLength: 255
          maxItems: 12
    ModuleNested:
      type: object
      additionalProperties: false
      description: Nested schema for module
      properties:
        singular_label:
          type: string
          description: 'Field: singular_label'
          maxLength: 255
        plural_label:
          type: string
          description: 'Field: plural_label'
          maxLength: 255
        api_name:
          type: string
          description: 'Field: api_name'
          maxLength: 255
        name:
          type: string
          description: 'Field: name'
          maxLength: 255
        id:
          type: string
          description: 'Field: id'
          maxLength: 255
    RelatedTriggersDetailsNested:
      type: object
      additionalProperties: false
      description: Nested schema for related_triggers_details
      properties:
        api_name:
          type: string
          description: 'Field: api_name'
          maxLength: 255
        module:
          $ref: '#/components/schemas/ModuleNested'
        name:
          type: string
          description: 'Field: name'
          maxLength: 255
        triggers:
          type: array
          description: 'Field: triggers'
          items:
            $ref: '#/components/schemas/TriggersNested'
          maxItems: 4
    WorkflowConfigurationsNested:
      type: object
      additionalProperties: false
      description: Nested schema for workflow_configurations
      properties:
        related_triggers_details:
          type: array
          description: 'Field: related_triggers_details'
          items:
            $ref: '#/components/schemas/RelatedTriggersDetailsNested'
          maxItems: 4
        triggers:
          type: array
          description: 'Field: triggers'
          items:
            $ref: '#/components/schemas/TriggersNested'
          maxItems: 10
        actions:
          type: array
          description: 'Field: actions'
          items:
            $ref: '#/components/schemas/ActionsNested'
          maxItems: 12
    RequiredParamMissingError:
      type: object
      additionalProperties: false
      description: 'Missing required parameter: module'
      properties:
        code:
          type: string
          description: Error code
          enum:
          - REQUIRED_PARAM_MISSING
        details:
          type: object
          additionalProperties: false
          description: Error details with validation information
          properties:
            param_name:
              type: string
              description: 'Detail field: param_name'
              maxLength: 255
        message:
          type: string
          description: Error message
          enum:
          - required param not found
        status:
          type: string
          description: Error status
          enum:
          - error
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    InvalidModuleResponse:
      type: object
      additionalProperties: false
      description: Invalid module given
      properties:
        code:
          type: string
          description: Error code
          enum:
          - INVALID_MODULE
        details:
          type: object
          additionalProperties: false
          description: Error details with validation information
          properties:
            param_name:
              type: string
              description: 'Detail field: param_name'
              maxLength: 255
        message:
          type: string
          description: Error message
          enum:
          - The value provided to the param is Invalid
        status:
          type: string
          description: Error status
          enum:
          - error
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    GetworkflowconfigurationsResponse200:
      type: object
      additionalProperties: false
      description: Indicates that the workflow configuration was retrieved successfully for the specified module.
      properties:
        workflow_configurations:
          $ref: '#/components/schemas/WorkflowConfigurationsNested'
    ActionsNested:
      type: object
      additionalProperties: false
      description: Nested schema for actions
      properties:
        is_clickable:
          type: boolean
          description: 'Field: is_clickable'
        associate_action:
          type: boolean
          description: 'Field: associate_action'
        limit_per_action:
          type:
          - integer
          - 'null'
          format: int32
          description: 'Field: limit_per_action'
        api_name:
          type: string
          description: 'Field: api_name'
          maxLength: 255
        supported_in_scheduled_action:
          type: boolean
          description: 'Field: supported_in_scheduled_action'
        name:
          type: string
          description: 'Field: name'
          maxLength: 255
        limit:
          type: integer
          format: int32
          description: 'Field: limit'
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter