Guide

How to build a connector from any API's docs

TL;DR: paste a link to the API's docs, tick what you need, sign in, and choose Test and save. Morph tests it live before anything is saved, and the finished connector becomes a tile in your library that anyone in your team can connect to with their own sign-in.

What you need

  • The API's docs: a link to an OpenAPI (Swagger) spec or a Postman collection, the file itself, or a few example requests from the docs (the ones that start with curl). Look for "API reference", "OpenAPI", "Swagger" or "Postman" on the product's developer site; a link ending in .json or .yaml is best.
  • A way to sign in: an API key, a token, or a username and password for the API.
  • A Pro plan or above, and permission to manage integrations in your organisation.

Build it, step by step

  1. Start from the library. Open Integrations, then Available providers. At the top, under Your library, choose Build from API docs (the Custom API tile does the same).
  2. Point Morph at the docs. Paste a link to the API's OpenAPI (Swagger) spec or Postman collection, upload the file, or paste two or three example requests copied from the docs. Choose Read the docs. It takes up to a minute.
  3. Tick what to read and write. Morph lists what the API can read and write. Each thing you read becomes a data type on a rule's source; each thing you write appears on a rule's Output. Writing is optional.
  4. Sign in. Enter the details the API asks for, such as an API key, a token, or a username and password. For a sandbox, choose Use a different address.
  5. Answer what the docs left open. If the docs didn't say something Morph needs, such as how pages work or which field is a record's id, it shows its guess under Please check. Keep it or change it.
  6. Test and save. Morph reads the first pages of everything you ticked, live, with your sign-in, and shows record counts and a few rows. If every read works, it saves the connection, and the connector joins your library.

While you work, a To finish line at the top of the dialog says what is left (sign in, answer a question, test), and each item takes you to the part that does it. Nothing is connected until you save.

Your library: build once, connect many times

Every connector you save appears at the top of Available providers, under Your library. Anyone in your organisation who manages integrations chooses Connect on its tile, enters their own sign-in, and is connected. Morph reads one record with those details before it keeps the connection, so a wrong key is caught straight away. There is nothing to build again, and only your organisation sees its library.

Use it for a second account on the same API, a sandbox and a live account side by side, or a colleague who needs their own access.

Using it in rules

  • As a source: pick the connection on a rule's source; each thing you chose to read is a data type, with the same filters as any other provider.
  • As a destination: pick it on the Output. A write runs on a schedule only after you have sent one real record to it with Send one record, so a misunderstood field never goes out in bulk.

Set the standard with a helper file

If other people's data will be written into your API (your customers, or a colleague mapping a spreadsheet), you can say how it should map once, for everyone. On the connection's card, open Mapping guide for a write, download the template, and fill in a row per field:

  • Aliases: the other names a column might have, such as Inv No; Invoice #.
  • From <system> columns: the field in Xero, QuickBooks or another system that feeds it.
  • Values: spellings to translate, such as Paid, PD => paid.
  • Format, Default and Required: how dates and numbers arrive, a value to use when nothing is mapped, and whether the field must be filled.

Upload it as CSV, Excel or JSON. Morph shows what it read before saving, then uses it for mapping suggestions and applies it to every record written.

Keeping it working

  • A connector is marked Needs attention after three failed runs in a row, or when a full read returns under half the records the last one did. Its owner is emailed once.
  • Update from docs reads the docs again and shows what changed. The new version replaces the live one only if everything the live one read still reads; otherwise it is kept aside.
  • Use version… switches back to an earlier version in one click.

Building with an AI agent

If you use Morph from Claude or another AI tool, the agent can read the docs, choose streams and test a draft for you. It never asks for your sign-in: it gives you a link to finish in Morph, and every library connector has its own connect link.

Want your own customers to send data into your product the same way? See how to embed the Morph importer.

FAQ

Common questions

Which plans include building connectors?

Pro and above, both to build a connector and to connect to one from your library. Each connection counts towards your plan's integrations like any other.

Does my API key go to an AI model?

No. Morph reads the docs to work out the connector; your sign-in details are encrypted, used only to call the API, and never sent to a model.

Does Morph keep the sample rows from the test?

No. They are shown to you in the dialog and never stored. A saved version keeps only the field names and types it saw, so a later version can be checked against them.

Who can see my connector?

Only your organisation (or only you, on an individual account). Each person who connects to it uses their own sign-in.

What kinds of API work today?

REST APIs that sign in with an API key, a bearer token or a username and password, described by an OpenAPI 3 or Swagger 2 spec, a Postman collection, or example curl requests. Sign-in with OAuth 2.0, GraphQL, SOAP, webhooks, deletes and docs that are only web pages or PDFs are not supported yet.

Connect the API you've been copying data out of

Build a connector from its docs on Pro and up