Getting Started

Quickstart

Get started with Xentom by creating your first workflow in minutes.

1
Step 1

To ensure triggers work correctly, especially webhook triggers, Xentom needs to be assigned an external URL that can be reached from outside your network.

If you're just getting started or want to test things quickly, using a tool like ngrok is the easiest way. It creates a secure tunnel to your local Xentom instance, giving you a public URL in seconds.

1
Step 1

Download and install ngrok from the official website: https://ngrok.com/download

2
Step 2

Once installed, start ngrok with the following command to expose your local instance:

Terminal
ngrok http 3000

After running this command, ngrok will generate a public URL that you can use for your Xentom instance. See Step 2 for more details.

2
Step 2

Start Xentom by running:

Terminal
xentom start --external-url <ngrok-url>

This will launch the Xentom interface and display a local server address in the terminal (e.g. http://localhost:3000).

3
Step 3

Open your web browser and navigate to the server address shown in the terminal. The Xentom dashboard will appear once the system is fully loaded.

4
Step 4

From the dashboard, switch to the Editor. This is where you can create, edit, and deploy your workflows visually.

5
Step 5

Open the Integrations tab to browse and install available integrations. Installed integrations allow your workflows to interact with external services and systems.

6
Step 6

Use the drag-and-drop interface to add steps, conditions, and actions. Each action can be configured using the integrations you have installed.

7
Step 7

Use the Run button in the top-right corner to test your workflow. After the run completes, check the run history and logs to confirm everything is working as expected and to troubleshoot any issues.

8
Step 8

Once the workflow is working as expected, click the Deploy button (located to the right of the Run button). After deployment, the workflow will run automatically whenever the Xentom instance is running.

On this page

No Headings