Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,7 @@
"pages": [
"integrations/introduction",
"integrations/add-integrations",
"integrations/migrate-legacy-integrations",
"integrations/remove-integrations"
]
},
Expand Down
4 changes: 4 additions & 0 deletions integrations/add-integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ The **Integrations & API Keys** browser displays all available integrations. Use

## Setting Up Integrations

<Info>
If a tool you're working with has a legacy Pipedream-based integration, a migration banner will appear on its configuration page. See [Migrate legacy integrations](/integrations/migrate-legacy-integrations) to learn how to upgrade it to a native integration.
</Info>

To begin using integrations with your AI agents:

1. Navigate to the **Integrations & API Keys** page from the left-hand menu of your Relevance AI account.
Expand Down
4 changes: 4 additions & 0 deletions integrations/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,21 @@

Let's explore each of these capabilities in detail.

## Native vs. Pipedream integrations

Check warning on line 20 in integrations/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

integrations/introduction.mdx#L20

Did you really mean 'Pipedream'?

Integrations fall into two types:

- **Native integrations** are built directly by Relevance AI. They offer deeper support, including pre-built tool steps and trigger events designed to work with agents out of the box.
- **Pipedream integrations** extend the catalog to 2,000+ services via a Pipedream connection. They support authentication and API access for a wide range of platforms not covered by native integrations.

Check warning on line 25 in integrations/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

integrations/introduction.mdx#L25

Did you really mean 'Pipedream'?

Check warning on line 25 in integrations/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

integrations/introduction.mdx#L25

Did you really mean 'Pipedream'?

<Tip>
Start with native integrations when available — they come with ready-made actions and triggers that require less configuration.
</Tip>

<Note>
If you have existing tools that use legacy Pipedream-based integrations, you can upgrade them using the migration wizard. See [Migrate legacy integrations](/integrations/migrate-legacy-integrations) for the step-by-step process.
</Note>

## 1. Connecting Integrations

The first step in leveraging integrations is connecting your external services to Relevance AI:
Expand All @@ -50,7 +54,7 @@
padding: '40px 0'
}}>
<iframe
src="https://app.supademo.com/embed/cm90wzs6k1ieheyp0a704pbpd?embed_v=2"

Check failure on line 57 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed is missing rounded corners — use the standard embed snippet. [technical: borderRadius: '10px' missing from iframe style]

Check failure on line 57 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed is missing the purple border — use the standard embed snippet. [technical: border: '3px solid #5E43CE' missing from iframe style]

Check failure on line 57 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed isn't using the standard wrapper — replace it with the snippet from the style guide. [technical: paddingTop: '56.25%' missing from wrapper <div>]
loading="lazy"
title="Connecting integrations"
allow="clipboard-write; fullscreen"
Expand Down Expand Up @@ -83,7 +87,7 @@
padding: '40px 0'
}}>
<iframe
src="https://app.supademo.com/embed/cm90ybkeb1ir3eyp09mxcynmk?embed_v=2"

Check failure on line 90 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed is missing rounded corners — use the standard embed snippet. [technical: borderRadius: '10px' missing from iframe style]

Check failure on line 90 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed is missing the purple border — use the standard embed snippet. [technical: border: '3px solid #5E43CE' missing from iframe style]

Check failure on line 90 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed isn't using the standard wrapper — replace it with the snippet from the style guide. [technical: paddingTop: '56.25%' missing from wrapper <div>]
loading="lazy"
title="Adding API keys"
allow="clipboard-write; fullscreen"
Expand Down Expand Up @@ -134,7 +138,7 @@
padding: '40px 0'
}}>
<iframe
src="https://app.supademo.com/embed/cm928e0t62ej5eyp0uej7b0h0?embed_v=2"

Check failure on line 141 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed is missing rounded corners — use the standard embed snippet. [technical: borderRadius: '10px' missing from iframe style]

Check failure on line 141 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed is missing the purple border — use the standard embed snippet. [technical: border: '3px solid #5E43CE' missing from iframe style]

Check failure on line 141 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed isn't using the standard wrapper — replace it with the snippet from the style guide. [technical: paddingTop: '56.25%' missing from wrapper <div>]
loading="lazy"
title="Setting up triggers"
allow="clipboard-write; fullscreen"
Expand Down Expand Up @@ -187,7 +191,7 @@
padding: '40px 0'
}}>
<iframe
src="https://app.supademo.com/embed/cm928q3zo2ejzeyp0vhb354og?embed_v=2"

Check failure on line 194 in integrations/introduction.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

Supademo embed isn't using the standard wrapper — replace it with the snippet from the style guide. [technical: paddingTop: '56.25%' missing from wrapper <div>]
loading="lazy"
title="Adding integration actions"
allow="clipboard-write; fullscreen"
Expand Down Expand Up @@ -310,6 +314,6 @@
While Relevance AI continually expands its integration library, you can also use webhook integrations or API tool steps to connect with services that don't have dedicated integrations yet.
</Accordion>
<Accordion title="I added an API key on the Integrations page, how does it get used?">
When you add an API key to a supported integration (e.g. Firecrawl, Lusha, Airtop), it's automatically used by all tool steps that require it. No extra configuration needed.

Check warning on line 317 in integrations/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

integrations/introduction.mdx#L317

Did you really mean 'Firecrawl'?

Check warning on line 317 in integrations/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

integrations/introduction.mdx#L317

Did you really mean 'Lusha'?

Check warning on line 317 in integrations/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

integrations/introduction.mdx#L317

Did you really mean 'Airtop'?
</Accordion>
</AccordionGroup>
81 changes: 81 additions & 0 deletions integrations/migrate-legacy-integrations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: 'Migrate legacy integrations'
description: 'Use the migration wizard to upgrade tools from Pipedream-based integrations to native integrations.'
sidebarTitle: 'Migrate legacy integrations'
---

## Overview

Legacy tool integrations are tools that connect to external services using Pipedream-based transformations. These were created before Relevance AI introduced native integrations, and they rely on Pipedream as an intermediary layer to handle authentication and API calls.

Check warning on line 9 in integrations/migrate-legacy-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

integrations/migrate-legacy-integrations.mdx#L9

Did you really mean 'Pipedream'?

Native integrations are built directly by Relevance AI and offer several improvements over Pipedream-based ones:

<CardGroup cols={2}>
<Card title="Better performance" icon="bolt">
Native integrations communicate directly with external services, reducing latency and improving reliability.
</Card>
<Card title="Pre-built actions" icon="puzzle-piece">
Native integrations come with ready-made tool steps so you can get started without manual configuration.
</Card>
<Card title="Trigger events" icon="bell">
Native integrations support trigger events that can automatically activate your agents when something happens in a connected platform.
</Card>
<Card title="First-party support" icon="headset">
Native integrations are maintained by the Relevance AI team, so issues are resolved faster.
</Card>
</CardGroup>

<Note>
The migration wizard is rolling out gradually to eligible tools. If your tool has a legacy Pipedream-based integration, you may see the migration banner on its configuration page.
</Note>

## When you'll see the migration banner

If you have a tool that uses a legacy Pipedream-based transformation, a banner notification will appear at the top of that tool's configuration page. The banner indicates that a native integration is now available for that service.

Click the banner to open the migration wizard modal. The wizard guides you through the migration process step by step and does not require any manual re-configuration of your tool settings.

## Migration process

<Steps>
<Step title="Connect OAuth accounts">
The wizard first prompts you to connect your account for the native integration. Click **Connect account** to be redirected to the third-party service's authentication page. Grant the necessary permissions, then you'll be redirected back to the wizard to continue.

If you have already connected a native integration account for this service on your **Integrations & API Keys** page, the wizard may allow you to select that existing connection instead.
</Step>

<Step title="Review parameter changes">
The wizard displays a side-by-side comparison of your current Pipedream-based configuration and the equivalent native integration configuration. Review how your existing parameters map to the new integration's fields.

Check that all settings carry over correctly before proceeding. If a parameter does not have a direct equivalent, the wizard will indicate this so you can decide how to handle it.
</Step>

<Step title="Complete migration">
Once you've reviewed the parameter mapping, click **Complete migration** to finalize the process. Your tool will be updated to use the native integration, and the legacy Pipedream transformation will be replaced.

Check warning on line 54 in integrations/migrate-legacy-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

integrations/migrate-legacy-integrations.mdx#L54

Did you really mean 'Pipedream'?
</Step>
</Steps>

## After migration

After the migration completes, test your tool to confirm it behaves as expected. Run it with representative inputs and verify the outputs match what you'd receive before migration.

Your existing tool run history is preserved. Agents that use the tool continue to work without requiring reconfiguration — the migration updates the tool's underlying integration while keeping its interface and parameters intact.

The tool now has access to all features available in the native integration, including any pre-built actions and trigger events added in the future.

## Frequently asked questions (FAQs)

<AccordionGroup>
<Accordion title="What happens to my existing tool configurations?">
The migration wizard maps your existing Pipedream-based parameters to their native integration equivalents. The wizard shows you this mapping before you finalize the migration, so you can review any differences. Your tool's name, description, and overall structure remain unchanged.
</Accordion>
<Accordion title="Will my agents be affected during migration?">
Migration is applied at the tool level, not the agent level. During the migration process, avoid running the tool until the migration is complete. Once finished, your agents can use the tool immediately — no changes to your agent configuration are needed.
</Accordion>
<Accordion title="Can I undo a migration?">
Migrations cannot be reversed automatically. If you need to revert to the previous Pipedream-based integration, contact the [Relevance AI support team](/get-started/support) for assistance.
</Accordion>
<Accordion title="What if I encounter issues during migration?">
If the wizard encounters a problem — such as an authentication failure or an unmappable parameter — it will display an error message explaining what went wrong. You can retry the relevant step or reach out to the [Relevance AI support team](/get-started/support) for help.

Check warning on line 79 in integrations/migrate-legacy-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

integrations/migrate-legacy-integrations.mdx#L79

Did you really mean 'unmappable'?
</Accordion>
</AccordionGroup>
Loading