Skip to main content

Creating an Integration

Prerequisites​

Before creating an integration, you need a workflow that:

  1. Contains an Integration Input trigger node as its entry point
  2. Contains an Integration Output node at the end to return a result
  3. Has at least one published revision

The Integration Input trigger is the equivalent of a function signature — it receives the inputs that callers provide. The Integration Output node defines what the integration returns.

Building the integration workflow​

1 — Add the Integration Input trigger​

In the Toolbox, find Integration Input under the Triggers tab (or Custom). Drop it on the canvas as the first node.

This node has no configuration. It will automatically receive the input fields you define when publishing.

2 — Add your logic​

Build the workflow normally between the trigger and the output node. Use expressions to reference the input fields passed in by the caller:

{{ $input.fieldName }}

3 — Add the Integration Output node​

Drop an Integration Output node at the end of the workflow. Configure the Output field to the value you want to return to the calling workflow. This can be a static value or an expression:

{{ HTTP Request.ResponseBody }}

4 — Publish the workflow​

Publish the workflow as you would any other. Note the Workflow Revision ID shown after publishing — you will need it when publishing an integration version.

Register the integration​

Go to Integrations → My Integrations and click New Integration.

FieldRequiredDescription
Workflow IDYesThe ID of the workflow to package. Found in the workflow URL
NameYesDisplay name shown in the store and toolbox
DescriptionNoA short description of what the integration does
CategoryNoGroups the integration in store filters (e.g. "Communication", "Data")
TagsNoComma-separated keywords for search
ScopeYesPrivate, Organisation, or Public

The integration is now registered. You can publish a version to make it available.