{
  "info": {
    "title": "workflows/automation-connectors",
    "version": ""
  },
  "paths": {
    "/api/workflows/automation-connectors": {
      "get": {
        "tags": [
          "automation-connectors"
        ],
        "summary": "List automation connectors",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationConnectorsList"
                }
              }
            },
            "description": "OK Response"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "schema": {
              "type": "string",
              "example": "eyJpZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
            },
            "required": false,
            "description": "Pagination cursor returned from a previous request."
          },
          {
            "in": "query",
            "name": "filter",
            "schema": {
              "type": "string",
              "example": "name eq \"Airtable\""
            },
            "required": false,
            "description": "Filters the result based on the specified criteria: name."
          },
          {
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer",
              "default": 100,
              "example": 50,
              "maximum": 200,
              "minimum": 1
            },
            "required": false,
            "description": "The number of automation connectors to retrieve."
          },
          {
            "in": "query",
            "name": "sort",
            "schema": {
              "enum": [
                "id",
                "-id",
                "+id",
                "name",
                "+name",
                "-name"
              ],
              "type": "string",
              "default": "id",
              "example": "-name"
            },
            "required": false,
            "description": "The field to sort by, with +- prefix indicating sort order. (`?sort=-name` => sort on the `name` field using descending order)."
          }
        ],
        "description": "Retrieves a list of automation connectors.",
        "operationId": "getAutomationConnectors",
        "x-qlik-visibility": "public",
        "x-qlik-stability": "stable",
        "x-qlik-deprecated": false,
        "x-qlik-replaces": [
          {
            "namespace": "",
            "uniqueIdentifier": "GET:/v1/automation-connectors"
          }
        ],
        "x-qlik-tier": {
          "tier": "1",
          "limit": 1000
        }
      }
    },
    "/api/workflows/automation-connectors/{connectorId}": {
      "get": {
        "tags": [
          "automation-connectors"
        ],
        "summary": "Get an automation connector",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationConnectorDetail"
                }
              }
            },
            "description": "OK Response"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "connectorId",
            "schema": {
              "type": "string",
              "format": "uuid",
              "example": "0d87347d-27c0-11ea-921c-022e6b5ea1e2"
            },
            "required": true,
            "description": "The unique identifier of the automation connector."
          }
        ],
        "description": "Retrieves the full details of an automation connector, including its connection parameters, blocks, and snippets.",
        "operationId": "getAutomationConnector",
        "x-qlik-visibility": "public",
        "x-qlik-stability": "stable",
        "x-qlik-deprecated": false,
        "x-qlik-tier": {
          "tier": "1",
          "limit": 1000
        }
      }
    },
    "/api/workflows/automation-connectors/{connectorId}/webhooks/configuration": {
      "get": {
        "tags": [
          "automation-connectors"
        ],
        "summary": "Get webhook configuration for an automation connector",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationConnectorWebhookConfiguration"
                }
              }
            },
            "description": "OK Response"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "connectorId",
            "schema": {
              "type": "string",
              "format": "uuid",
              "example": "0d87347d-27c0-11ea-921c-022e6b5ea1e2"
            },
            "required": true,
            "description": "The unique identifier of the automation connector."
          }
        ],
        "description": "Retrieves the webhook configuration for an automation connector, including its events and event parameters.",
        "operationId": "getConnectorWebhookConfiguration",
        "x-qlik-visibility": "public",
        "x-qlik-stability": "stable",
        "x-qlik-deprecated": false,
        "x-qlik-tier": {
          "tier": "1",
          "limit": 1000
        }
      }
    }
  },
  "openapi": "3.0.0",
  "components": {
    "responses": {
      "BadRequest": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "Bad Request"
      },
      "Forbidden": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "Forbidden"
      },
      "InternalServerError": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "Internal Server Error"
      },
      "NotFound": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "Not found"
      },
      "ServiceUnavailable": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "Service Unavailable"
      },
      "Unauthorized": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        },
        "description": "Unauthorized"
      }
    },
    "schemas": {
      "AutomationConnectorBlock": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "9d94bef0-b28c-11eb-8dba-01593c457362",
            "description": "The unique identifier of the block."
          },
          "name": {
            "type": "string",
            "example": "List Records",
            "description": "The name of the block."
          },
          "role": {
            "type": "string",
            "example": "list",
            "description": "The role of the block."
          },
          "inputs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationConnectorParam"
            },
            "description": "The input parameters for this block."
          },
          "objectType": {
            "type": "string",
            "example": "Record",
            "nullable": true,
            "description": "The object type this block operates on."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "The description of the block."
          },
          "exampleOutput": {
            "oneOf": [
              {
                "type": "object"
              },
              {
                "type": "array",
                "items": {
                  "oneOf": [
                    {
                      "type": "object"
                    },
                    {
                      "type": "string"
                    },
                    {
                      "type": "number"
                    },
                    {
                      "type": "boolean"
                    }
                  ]
                }
              },
              {
                "type": "string"
              }
            ],
            "nullable": true,
            "description": "An example of the output this block produces."
          }
        }
      },
      "AutomationConnectorDetail": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "example": "Airtable",
            "description": "The name of the automation connector."
          },
          "blocks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationConnectorBlock"
            },
            "description": "The available blocks (endpoints) for this connector."
          },
          "params": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationConnectorParam"
            },
            "description": "The connection parameters required to authenticate with this connector."
          },
          "billable": {
            "type": "boolean",
            "example": true,
            "description": "Indicates if the connector is billable."
          },
          "snippets": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationConnectorSnippet"
            },
            "description": "The available snippet templates for this connector."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "The description of the automation connector."
          },
          "hasWebhooks": {
            "type": "boolean",
            "example": true,
            "description": "Indicates if the connector supports webhooks."
          },
          "connectDocumentation": {
            "type": "string",
            "nullable": true,
            "description": "Documentation for setting up a connection with this connector."
          }
        }
      },
      "AutomationConnectorParam": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
            "description": "The unique identifier of the parameter."
          },
          "name": {
            "type": "string",
            "example": "API Key",
            "description": "The name of the parameter."
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The available options for the parameter."
          },
          "setting": {
            "type": "boolean",
            "example": false,
            "description": "Indicates whether the parameter is a setting."
          },
          "optional": {
            "type": "boolean",
            "example": false,
            "description": "Indicates whether the parameter is optional."
          },
          "fieldType": {
            "type": "string",
            "example": "text",
            "description": "The field type of the parameter."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "The description of the parameter."
          },
          "exampleValue": {
            "type": "string",
            "nullable": true,
            "description": "An example value for the parameter."
          }
        }
      },
      "AutomationConnectorsList": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationConnectorsListObject"
            }
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          }
        }
      },
      "AutomationConnectorsListObject": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "example": "Airtable",
            "description": "The name of an automation connector.",
            "x-qlik-filterable": true
          },
          "billable": {
            "type": "boolean",
            "example": "true",
            "description": "Indicates if the connector is billable."
          },
          "logoLarge": {
            "type": "string",
            "example": "https://cdn.qlikcloud.com/automations/logos/a2649cabda63b339ebc68a0c8d028f08.png",
            "nullable": true,
            "description": "The URL to the large logo of the connector."
          },
          "logoSmall": {
            "type": "string",
            "example": "https://cdn.qlikcloud.com/automations/logos/a14638b5bf73f6d360f3c2732cf94bd9.png",
            "nullable": true,
            "description": "The URL to the small logo of the connector."
          },
          "logoMedium": {
            "type": "string",
            "example": "https://cdn.qlikcloud.com/automations/logos/db2e3454fd01a6c3a53c09609a0b504f.png",
            "nullable": true,
            "description": "The URL to the medium logo of the connector."
          },
          "description": {
            "type": "string",
            "example": "Airtable is a cloud collaboration service.",
            "nullable": true,
            "description": "The description of the automation connector."
          },
          "hasWebhooks": {
            "type": "boolean",
            "example": "true",
            "description": "Indicates if the connector supports webhooks."
          }
        }
      },
      "AutomationConnectorSnippet": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "description": "The unique identifier of the snippet."
          },
          "name": {
            "type": "string",
            "example": "Sync Records",
            "description": "The name of the snippet."
          },
          "role": {
            "type": "string",
            "nullable": true,
            "description": "The role of the snippet."
          },
          "inputs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationConnectorSnippetInput"
            },
            "description": "The input fields for this snippet."
          },
          "objectType": {
            "type": "string",
            "example": "Record",
            "nullable": true,
            "description": "The object type this snippet operates on."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "The description of the snippet."
          },
          "exampleOutput": {
            "oneOf": [
              {
                "type": "object"
              },
              {
                "type": "array",
                "items": {
                  "oneOf": [
                    {
                      "type": "object"
                    },
                    {
                      "type": "string"
                    },
                    {
                      "type": "number"
                    },
                    {
                      "type": "boolean"
                    }
                  ]
                }
              },
              {
                "type": "string"
              }
            ],
            "nullable": true,
            "description": "An example of the output this snippet produces."
          }
        }
      },
      "AutomationConnectorSnippetInput": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "description": "The unique identifier of the snippet input."
          },
          "name": {
            "type": "string",
            "example": "Table Name",
            "description": "The display name (prompt) of the input."
          },
          "options": {
            "oneOf": [
              {
                "type": "object"
              },
              {
                "type": "array",
                "items": {}
              }
            ],
            "nullable": true,
            "description": "The available options for this input."
          },
          "optional": {
            "type": "boolean",
            "example": false,
            "description": "Indicates whether the input is optional."
          },
          "fieldType": {
            "type": "string",
            "example": "text",
            "description": "The field type of the input."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "The help text for this input."
          }
        }
      },
      "AutomationConnectorWebhookConfiguration": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
            "description": "The unique identifier of the webhook configuration."
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationConnectorWebhookEvent"
            },
            "description": "The available webhook events for this connector."
          },
          "automatic": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the webhook is set up automatically."
          }
        }
      },
      "AutomationConnectorWebhookEvent": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
            "description": "The unique identifier of the webhook event."
          },
          "name": {
            "type": "string",
            "example": "Record Created",
            "description": "The name of the webhook event."
          },
          "role": {
            "type": "string",
            "example": "create",
            "description": "The role of the webhook event."
          },
          "params": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationConnectorWebhookEventParam"
            },
            "description": "The parameters available for this webhook event."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "The description of the webhook event."
          },
          "exampleOutput": {
            "oneOf": [
              {
                "type": "object"
              },
              {
                "type": "array",
                "items": {
                  "oneOf": [
                    {
                      "type": "object"
                    },
                    {
                      "type": "string"
                    },
                    {
                      "type": "number"
                    },
                    {
                      "type": "boolean"
                    }
                  ]
                }
              },
              {
                "type": "string"
              }
            ],
            "nullable": true,
            "description": "An example of the payload this event produces."
          }
        }
      },
      "AutomationConnectorWebhookEventParam": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
            "description": "The unique identifier of the webhook event parameter."
          },
          "name": {
            "type": "string",
            "example": "table_id",
            "description": "The name of the parameter."
          },
          "type": {
            "type": "string",
            "example": "text",
            "description": "The type of the parameter."
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The available options for this parameter."
          },
          "required": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the parameter is required."
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "code",
          "title"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "The unique code for the error"
          },
          "title": {
            "type": "string",
            "description": "A summary of what went wrong"
          },
          "detail": {
            "type": "string",
            "description": "May be used to provide additional details"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          },
          "traceId": {
            "type": "string",
            "description": "A way to trace the source of the error."
          }
        }
      },
      "Links": {
        "properties": {
          "next": {
            "$ref": "#/components/schemas/PaginationLink"
          },
          "prev": {
            "$ref": "#/components/schemas/PaginationLink"
          }
        }
      },
      "PaginationLink": {
        "properties": {
          "href": {
            "type": "string",
            "nullable": true,
            "description": "The URL to a resource request"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://{tenant}.{region}.qlikcloud.com",
      "variables": {
        "region": {
          "default": "us",
          "description": "The region the tenant is hosted in"
        },
        "tenant": {
          "default": "your-tenant",
          "description": "Name of the tenant that will be called"
        }
      }
    }
  ]
}