Custom connectors

A custom connector is a service you describe yourself: any API on the internet that takes a key. Once it is created, your apps use it like any connector on the list, through Setherion, with the key kept on our servers.

Press + at the top right of the Connectors page, then Custom connector, and fill in:

• Details. A Display name, a Short description for the list, a longer Description, a Category, and an optional documentation address.
• Authentication. How the key travels: a Bearer token, an API key in a header (you name the header), an API key in the address (you name the parameter), or a Username and password. You can also name what people are asked for, such as "Password". What requests to this API will look like shows it as you choose. Then the API base URL, where every request starts, and a Test request: a simple call that fails without a valid key, like one that returns the current account.
• Who may use it. Only your app's team (the default), Visitors can read, or Anybody, then the kinds of request apps may send: GET reads, the others change things. With Visitors can read, anybody who opens the app may read and only the team changes things. With Anybody, everyone may make every call you allowed, and calls are limited more tightly for each visitor, so choose it only for an API built for that.
• Agent knowledge. Optional, and worth writing: the paths, a request and an answer for each, and anything easy to get wrong. Setherion reads it when it builds your apps. Without it, Setherion has to guess the paths, and a guess can be wrong: say which path returns your own account, for example. Never paste a key here.

No key goes in the form. Create opens the connector's page, where you add the key, press Test connection, and connect, as for any other service. Edit and Delete are on that page too. Deleting it removes its key as well, and apps that use it stop reaching it at once.

Ask. Once it is connected and ticked for an app, ask for it by name: "Show my open projects from Acme on the dashboard." "Add a button that creates a task in Acme."

• The API base URL has to start with https:// and be on the public internet. An address inside a private network, an IP address, or one with a port other than 443 is refused, when you save it and again on every call.
• Custom connectors are yours: they are not lent to the members of a team workspace, and a workspace that lists the connectors its apps may use leaves them out.
• You can have up to 25.
• For a single key one app needs, Secrets may be enough.