Quickstart
Xentom's integration system allows developers to extend the platform's capabilities by creating custom connections to external services and APIs. Integrations are the building blocks that enable workflows to interact with third-party systems, from simple REST APIs to complex authentication flows.
Create a new integration project using xentom init.
xentom init my-awesome-integrationYou will be prompted to enter an integration name in the format @<team-name>/<integration-name>.
The team name should correspond to the team responsible for maintaining the integration.
This naming convention is only required if you plan to publish the integration to the Xentom Platform.
A new directory named my-awesome-integration will be created with the default integration structure.
my-awesome-integration/
├── src/
│ ├── nodes/
│ │ └── index.ts # Node definitions
│ └── index.ts # Main integration entry point
├── package.json # Project dependencies and scripts
├── tsconfig.json # TypeScript configuration
├── CHANGELOG.md # Integration changelog
└── README.md # Integration documentationStart the development server using xentom dev.
cd my-awesome-integration
xentom devOpen http://localhost:3000 in your browser to view and test your integration during development.
Begin editing your integration. The development server automatically reloads whenever you save changes.
When you are ready to prepare your integration for distribution, run xentom pack:
xentom packThis generates a tgz file in the dist directory. You can upload this file to your self-hosted Xentom Workflow instance.
dist/
└── team-my-awesome-integration-0.0.1.tgzTo publish your integration to the Xentom Platform, log in and run xentom publish:
xentom publish