Build an integration
Set up a connector — a reusable connection to an external system (Slack, a database, an HTTP API, object storage, and more). A process service task can call a connector, and an agent can be given a connector as a tool. Connectors live at the organization level; “integration” and “connector” mean the same thing in the UI.
Before you start
Section titled “Before you start”- You’re an organization owner or admin — connectors are managed at Settings → Integrations.
- You have the connection details (endpoint, credentials — API key, OAuth, and so on).
- Credentials are stored as secrets, referenced by name, never readable again from the UI.
-
Open the connector catalog. Go to Settings → Integrations in the organization sidebar. The page lists your connectors and the catalog of types you can add.
Screenshot placeholderSettings → Integrations — the connector catalogReplace with real capture from app.superagent.studio -
Add a connector. Click Add Integration and pick the Connector Type — Slack, Email, SMS, Database, CSV, Google Sheets, File Storage, HubSpot, API Call (HTTP/REST), Webhook, Document, Message Queue, or HTTP Polling. The setup form changes to match the type.
-
Name it and set the scope. Give it an organization-unique name (
erp-prod), and choose a Project Scope — organization-wide, or limited to one project. -
Fill in the setup. Enter the connector’s configuration (endpoint, defaults) and its credentials, which are stored as secrets and referenced by name.
-
Save and test. Save the connector, and use its test action to confirm it can reach the system and authenticate.
-
Use it. Two ways:
- In a process — add a service task, set its type to SDK Connector, pick this connector (optionally pin a version), choose the operation, and map inputs and outputs to process variables.
- As an agent tool — hand the connector to an agent on its Tools tab so the agent can call it. See Give an agent tools.
Common variations
Section titled “Common variations”- Custom HTTP. Not a specific system in the list? Use API Call (HTTP/REST) (or Webhook) and provide the request shape yourself.
- Versioning. Connectors are versioned — publish a version and pin it on a service task, so a process’s behaviour doesn’t shift when the connector changes later.
- Org-wide vs project. Set the Project Scope to organization-wide for a shared connection (a corporate ERP), or to a single project to keep it contained.
Troubleshooting
Section titled “Troubleshooting”- Save fails with “cannot reach host.” The connector runs inside the platform’s network; if your system is firewalled, allowlist the platform’s egress. The error shows the source IP.
- A step fails with 401/403 at run time. The credential expired or its permissions were revoked. Rotate the secret (see Manage secrets); the next run picks up the new value automatically.