Automation connectors

Download OpenAPI spec

Automation connectors let you integrate third-party services and applications into your data analytics workflows. Use this API to discover available connectors and understand billing characteristics.

Preferred API

This API replaces the legacy Automation connectors API. Use this API for all new implementations.

List automation connectors

Retrieves a list of automation connectors.

Facts

Rate limit Tier 1 (1000 requests per minute)
Replaces

Query Parameters

  • cursorstring

    Pagination cursor returned from a previous request.

  • filterstring

    Filters the result based on the specified criteria: name.

  • limitinteger

    The number of automation connectors to retrieve.

    minimum = 1, maximum = 200, default = 100, default = 100

  • sortstring

    The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order).

    Can be one of: "id""-id""+id""name""+name""-name"

    default = "id"

Responses

200

OK Response

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring

        format = "uuid"

      • namestring

        The name of an automation connector.

      • billableboolean

        Indicates if the connector is billable.

      • logoLargestring

        The URL to the large logo of the connector.

      • logoSmallstring

        The URL to the small logo of the connector.

      • logoMediumstring

        The URL to the medium logo of the connector.

      • descriptionstring

        The description of the automation connector.

      • hasWebhooksboolean

        Indicates if the connector supports webhooks.
    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring

          The URL to a resource request
      • prevobject
        Show prev properties
        • hrefstring

          The URL to a resource request

400

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

503

Service Unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.
GET /api/workflows/automation-connectors 
// qlik-api has not implemented support for `GET /api/workflows/automation-connectors` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/workflows/automation-connectors',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik workflows automation-connector ls
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automation-connectors" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
      "name": "Airtable",
      "billable": "true",
      "logoLarge": "https://cdn.qlikcloud.com/automations/logos/a2649cabda63b339ebc68a0c8d028f08.png",
      "logoSmall": "https://cdn.qlikcloud.com/automations/logos/a14638b5bf73f6d360f3c2732cf94bd9.png",
      "logoMedium": "https://cdn.qlikcloud.com/automations/logos/db2e3454fd01a6c3a53c09609a0b504f.png",
      "description": "Airtable is a cloud collaboration service.",
      "hasWebhooks": "true"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Get an automation connector

Retrieves the full details of an automation connector, including its connection parameters, blocks, and snippets.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • connectorIdstring
    Required

    The unique identifier of the automation connector.

    format = "uuid"

Responses

200

OK Response

  • application/jsonobject
    Show application/json properties
    • idstring

      format = "uuid"

    • namestring

      The name of the automation connector.

    • blocksarray of objects

      The available blocks (endpoints) for this connector.

      Show blocks properties
      • idstring

        The unique identifier of the block.

        format = "uuid"

      • namestring

        The name of the block.

      • rolestring

        The role of the block.

      • inputsarray of objects

        The input parameters for this block.

        Show inputs properties
        • idstring

          The unique identifier of the parameter.

          format = "uuid"

        • namestring

          The name of the parameter.

        • optionsarray of strings

          The available options for the parameter.

        • settingboolean

          Indicates whether the parameter is a setting.

        • optionalboolean

          Indicates whether the parameter is optional.

        • fieldTypestring

          The field type of the parameter.

        • descriptionstring

          The description of the parameter.

        • exampleValuestring

          An example value for the parameter.
      • objectTypestring

        The object type this block operates on.

      • descriptionstring

        The description of the block.

      • exampleOutputobject|array|string

        An example of the output this block produces.

        One of:
        • object
        • array of object,string,number,booleans
          One of:
          • object
          • string
          • number
          • boolean
        • string
    • paramsarray of objects

      The connection parameters required to authenticate with this connector.

      Show params properties
      • idstring

        The unique identifier of the parameter.

        format = "uuid"

      • namestring

        The name of the parameter.

      • optionsarray of strings

        The available options for the parameter.

      • settingboolean

        Indicates whether the parameter is a setting.

      • optionalboolean

        Indicates whether the parameter is optional.

      • fieldTypestring

        The field type of the parameter.

      • descriptionstring

        The description of the parameter.

      • exampleValuestring

        An example value for the parameter.
    • billableboolean

      Indicates if the connector is billable.

    • snippetsarray of objects

      The available snippet templates for this connector.

      Show snippets properties
      • idstring

        The unique identifier of the snippet.

        format = "uuid"

      • namestring

        The name of the snippet.

      • rolestring

        The role of the snippet.

      • inputsarray of objects

        The input fields for this snippet.

        Show inputs properties
        • idstring

          The unique identifier of the snippet input.

          format = "uuid"

        • namestring

          The display name (prompt) of the input.

        • optionsobject|array

          The available options for this input.

          One of:
          • object
          • array of undefineds
        • optionalboolean

          Indicates whether the input is optional.

        • fieldTypestring

          The field type of the input.

        • descriptionstring

          The help text for this input.
      • objectTypestring

        The object type this snippet operates on.

      • descriptionstring

        The description of the snippet.

      • exampleOutputobject|array|string

        An example of the output this snippet produces.

        One of:
        • object
        • array of object,string,number,booleans
          One of:
          • object
          • string
          • number
          • boolean
        • string
    • descriptionstring

      The description of the automation connector.

    • hasWebhooksboolean

      Indicates if the connector supports webhooks.

    • connectDocumentationstring

      Documentation for setting up a connection with this connector.

400

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

404

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

503

Service Unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.
GET /api/workflows/automation-connectors/{connectorId} 
// qlik-api has not implemented support for `GET /api/workflows/automation-connectors/{connectorId}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/workflows/automation-connectors/{connectorId}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
# qlik-cli has not implemented support for GET /api/workflows/automation-connectors/{connectorId} yet.
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automation-connectors/{connectorId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
  "name": "Airtable",
  "blocks": [
    {
      "id": "9d94bef0-b28c-11eb-8dba-01593c457362",
      "name": "List Records",
      "role": "list",
      "inputs": [
        {
          "id": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
          "name": "API Key",
          "options": [
            "string"
          ],
          "setting": false,
          "optional": false,
          "fieldType": "text",
          "description": "string",
          "exampleValue": "string"
        }
      ],
      "objectType": "Record",
      "description": "string",
      "exampleOutput": {}
    }
  ],
  "params": [
    {
      "id": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
      "name": "API Key",
      "options": [
        "string"
      ],
      "setting": false,
      "optional": false,
      "fieldType": "text",
      "description": "string",
      "exampleValue": "string"
    }
  ],
  "billable": true,
  "snippets": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Sync Records",
      "role": "string",
      "inputs": [
        {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "Table Name",
          "options": {},
          "optional": false,
          "fieldType": "text",
          "description": "string"
        }
      ],
      "objectType": "Record",
      "description": "string",
      "exampleOutput": {}
    }
  ],
  "description": "string",
  "hasWebhooks": true,
  "connectDocumentation": "string"
}

Get webhook configuration for an automation connector

Retrieves the webhook configuration for an automation connector, including its events and event parameters.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • connectorIdstring
    Required

    The unique identifier of the automation connector.

    format = "uuid"

Responses

200

OK Response

  • application/jsonobject
    Show application/json properties
    • idstring

      The unique identifier of the webhook configuration.

      format = "uuid"

    • eventsarray of objects

      The available webhook events for this connector.

      Show events properties
      • idstring

        The unique identifier of the webhook event.

        format = "uuid"

      • namestring

        The name of the webhook event.

      • rolestring

        The role of the webhook event.

      • paramsarray of objects

        The parameters available for this webhook event.

        Show params properties
        • idstring

          The unique identifier of the webhook event parameter.

          format = "uuid"

        • namestring

          The name of the parameter.

        • typestring

          The type of the parameter.

        • optionsarray of strings

          The available options for this parameter.

        • requiredboolean

          Indicates whether the parameter is required.
      • descriptionstring

        The description of the webhook event.

      • exampleOutputobject|array|string

        An example of the payload this event produces.

        One of:
        • object
        • array of object,string,number,booleans
          One of:
          • object
          • string
          • number
          • boolean
        • string
    • automaticboolean

      Indicates whether the webhook is set up automatically.

400

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

404

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.

503

Service Unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • titlestring
        Required

        A summary of what went wrong

      • detailstring

        May be used to provide additional details
    • traceIdstring

      A way to trace the source of the error.
GET /api/workflows/automation-connectors/{connectorId}/webhooks/configuration 
// qlik-api has not implemented support for `GET /api/workflows/automation-connectors/{connectorId}/webhooks/configuration` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/workflows/automation-connectors/{connectorId}/webhooks/configuration',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
# qlik-cli has not implemented support for GET /api/workflows/automation-connectors/{connectorId}/webhooks/configuration yet.
curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automation-connectors/{connectorId}/webhooks/configuration" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
  "events": [
    {
      "id": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
      "name": "Record Created",
      "role": "create",
      "params": [
        {
          "id": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
          "name": "table_id",
          "type": "text",
          "options": [
            "string"
          ],
          "required": true
        }
      ],
      "description": "string",
      "exampleOutput": {}
    }
  ],
  "automatic": true
}