Base Connector Setup

Collection of parameters for the general setup of a connector which all actions and endpoints inherit.

Base Connector configuration

{
    "name": "",
    "contype": "",
    "status": "",
    "auth_config": {},
    "base_domain": "",
    "header": {},
    "url_token_extension": "",
    "search_config": null,
    "pagination_config": null,
    "external_schema_config": null,
    "image_url": "",
    "display_on_landing_pages": false,
    "internal_docs": null,
    "external_docs": null,
    "external_auth_docs": null,
    "external_swagger_docs": null,
    "short_description": null,
    "long_description": null,
    "con_arrow": null,
    "order_rank": 1,
    "tags": []
}

Key

Type

Description

name

String

Name of connector

contype

String

Options:

connector - Any SaaS app or system
helper - Helper are only internally used by Locoia

status

String

Options:

active - live and available for everyone
draft - while debugging; only visible for you and the super admin of Locoia. If a connector's status is set to draft, only Admin users can see it inside the app. However, it will still be visible to regular users if it has been added to a flow while the status was set to active. But the side-panel will not be opened when the users clicks on the connector inside the flow
paused - a connector that is used by running flows but needs to be paused for some reasons. Be careful: All flows containing this Connector will not be executed

auth_config

Object

Described in the Authentication Types section.

base_domain

String

The base domain of an API, e.g. https://api.hubapi.com/ Base Domain can be left empty on the Connector setup itself and a custom domain asked for in the authentication configuration form presented to the user can be marked as required, so that always the custom domain will be used.

header

Object

{
    "token_in_header": true, 
    "content_type": "application/json", 
    "header_key": "Authorization", 
    "token_format": "{{token}}", 
    "token_prefix":"{{token_format}}"
}

url_token_extension

String

Not recommended! Some connectors only allow to add an API key to the end of a url as a query string parameter:

{{endpoint}}hapikey={{token}}

search_config

Object

Described in Search Automation.

pagination_config

Object

Described in Pagination Automation.

external_schema_config

Object

Described in GraphQL APIs.

image_url

String

The file name of the logo image, e.g. hubspot.svg. Ideally an svg should be used. If a png is used, it must be transparent and min 350px width and height.

display_on_landing_pages

Boolean

Determines if a connector should be displayed on the landing page: https://www.locoia.com/connector/integrations

internal_docs

String

Link to docs of Locoia, e.g.: https://docs.locoia.com/connectors/connectors/hubspot

external_docs

String

Links to API Docs e.g.: https://developers.hubspot.com/docs/api/overview

external_auth_docs

String

Link pointing to external authentication docs e.g.: https://developers.hubspot.com/docs/api/working-with-oauth

external_swagger_docs

String

Link pointing to external swagger docs, the JSON file itself.

short_description

String

A short description of max 160 characters.

long_description

String

A longer description of max 2000 characters.

con_arrow

Object

An object describing arrows attached to a Helper. E.g.:

{
  "links": [
    {
      "label": "Case 1",
      "direction": "down"
    },
    {
      "label": "Case 2",
      "direction": "down"
    },
    {
      "label": "Case n - For each case add an arrow",
      "direction": "right"
    }
  ]
}

order_rank

Number

A rank of the order in which the Connector will be displayed