Skip to main content

Code-Native Integrations

New to code-native?

Are you new to our developer-first, code-native SDK? Check out our getting started guide to build your first integration.

When building an integration, you can use either the low-code designer or create a TypeScript project using your favorite IDE. We call integrations built with code "code-first integrations" or "code-native integrations" (CNIs), and this option is ideal for developers who want to build integrations entirely in code, and take advantage of the full power of TypeScript and Node.js. The pages in this section cover each part of a code-native integration: defining flows, building the config wizard, configuring webhook endpoints, and testing your integration.

You can reuse existing components for API calls, connections, triggers, and data sources. For components available on npm, install the package in your project and use it directly from TypeScript. The package includes the component's code and types, so you can manage it alongside your other dependencies.

Use the integration authoring guidelines to design customer configuration, plan for large syncs, and make failures recoverable.

A code-native integration being built in Visual Studio Code

For example code-native integrations, please visit our GitHub repository.

The rest of the platform is the same

Regardless of how you build your integrations, the rest of the platform remains identical. Both code-native and low-code integrations are deployed to the same runner environment. Both can include OAuth 2.0 connections, data sources, and other advanced configuration wizard steps. Integrations built using either approach can include multiple flows and can be added to your integration marketplace. The same logging, monitoring, and alerting tools are available for both types of integrations.

The key difference lies in how you build the integration - you either assemble a set of low-code steps in the designer or write TypeScript code to accomplish the same task.