API Connectors for SaaS Automation: How They Work

What an API connector contains, how it runs in a workflow, and where custom requests take over.

3 min read

On this page

An API connector is a packaged way to talk to a specific external service. Instead of configuring every request from scratch, builders choose a service, pick an operation and fill in the inputs. In SaaS automation platforms, connectors are what make integrations quick to build.

This guide explains how API connectors work, what they contain, and their limits.

What an API connector contains#

A connector typically bundles:

Component	Purpose
Base configuration	The service's base URL, API version and default headers
Authentication	How credentials are obtained and applied, such as OAuth or API keys
Operations	Predefined requests, such as "list contacts" or "create invoice"
Input schemas	Which parameters each operation accepts and which are required
Output schemas	The shape of each operation's response, so later steps can use fields
Pagination	How to fetch all results when responses are split across pages
Error mapping	How the service's errors are interpreted
Triggers	Events or polling mechanisms that can start workflows

How connectors work in a workflow#

When a workflow step uses a connector operation:

The platform builds the request from the operation's definition and the step's inputs.
It applies the connected user's credentials.
It sends the request and handles pagination if needed.
It parses the response according to the output schema.
It passes the result to the next step, or handles the error.

Builders see a form with inputs and a structured output, rather than raw HTTP.

A connector operation is a predefined API call that runs in the connected user's context like any other step.

Connectors in embedded SaaS automation#

In an embedded platform, connectors run for many users. That adds requirements:

Per-user authorization: each execution uses the credentials of the user it runs for.
Tenant isolation: one user's data and credentials are never used for another.
Per-user triggers: webhooks or polling scoped to each connected account.
Consistent behaviour: the same operation behaves the same for every user, within the limits of their permissions at the provider.

The limits of connectors#

Connectors trade flexibility for convenience.

Coverage gaps. A connector exposes the operations its author chose. Newer endpoints, less common operations and custom objects may be missing.

Version lag. When a provider releases a new API version, connectors may take time to catch up.

Abstraction. Connectors can hide provider-specific details that matter for debugging.

Custom fields. Many business tools rely on customer-specific fields that a static schema can't fully describe.

Connectors and custom requests together#

The practical answer is to combine them. Use connector operations for common tasks, and fall back to a custom API request when a connector doesn't cover what you need, using the same connection and credentials.

A good platform makes switching between them easy, so a missing operation doesn't block a workflow.

Building your own connector#

If you're building connectors for your own platform or product:

Start from real use cases and include the operations they need.
Define input and output schemas accurately, including optional fields.
Handle pagination and rate limits inside the connector.
Map errors into consistent categories: authorization, validation, rate limit, temporary, permanent.
Test against the provider's sandbox regularly to catch API changes.
Document what the connector doesn't cover.

Where Pathfix fits#

Pathfix Automation lets you connect supported provider APIs or define custom API calls, with an API Builder for configuring requests and using available API definitions. Workflows run in each connected user's context, and connections for supported OAuth providers rely on Pathfix OAuth.

Pathfix OAuth itself is not a connector library or unified API: it handles authorization, token storage, refresh and authenticated API passthrough, and your code calls providers' own APIs.

See the Automation documentation for current details.

Frequently asked questions#

Is a connector the same as an SDK?#

Similar in purpose, different in form. An SDK is code you call from your application. A connector is a configuration a platform uses to make API calls inside workflows.

What if a connector is missing an operation I need?#

Use a custom API request with the same connection, if the platform supports it.

Do connectors handle authentication automatically?#

They define how authentication works. The platform applies each user's credentials when the operation runs.