Integrations

Integrations 

Introduction

Integrations and Playbooks allow you to connect and work with metadata values, enabling seamless communication between Oneflow and your other systems. With this functionality, you can both send and retrieve data automatically.

In this article, we’ll take a closer look at how it works and how you can use it to simplify your day-to-day workflows. 

Integrations

When an integration is activated in the Marketplace, it will appear in the Integrations tab. This tab provides an overview of all active integrations, as well as more detailed information for each one when selected.

In the list of integrations, you’ll also find an option called Custom integration if activated through Marketplace. This allows you to connect your own integrations by generating API tokens and configuring webhook URLs. You can use these to build and manage custom connections. For more information, see Custom integrations.

When selecting an integration, you’ll see the following tabs:

Details

An overview of the integration. 

Integration Blueprints

Integration blueprints act as containers for the data fields used by an integration.

For native integrations, a blueprint is automatically created and includes both default fields and any custom fields that have been synced from the integration.

Custom integrations do not include a default blueprint. You’ll need to create one manually.  
🔗Learn more about creating custom blueprints here

When you select a blueprint, you’ll see details about the synced data fields from the integration, as well as any connected playbooks.

API tokens

This tab shows the status of the API token for the integration.

For native integrations, the API token is automatically generated when you enable the integration from the marketplace. These tokens are managed automatically and are not visible in this view.

For custom integrations, this is where you can create and manage your own API tokens.

Webhooks

This tab displays the webhooks used by native integrations.
For custom integrations, this is where you can create and manage your own webhooks.

Custom Integrations

The integration list does not include Custom integration option by default. To enable the custom integration, head over to Marketplace, click on the Custom Integration extension and Enable. This allows you to set up your own integrations with Oneflow.

With custom integrations, you can create your own integration blueprints, generate API tokens, and configure webhook URLs to connect external systems.

When you select Custom integration from the list, you’ll see the following tabs:

Details

An overview of the custom integration.

Integration Blueprint

As mentioned above, custom integrations do not include a default blueprint. To use one, you’ll need to create it manually. This acts as a container of data you want to control with the API. You would therefore only need to create a custom blueprint if you plan to use a custom integration.

Create a blueprint

Follow these steps to create a blueprint:

1. Go to Admin > Integrations.
2. Click on Custom integration in the integration list.
3. Open the Integration blueprints tab > Click Create integration blueprint.
4. Enter a name and description > Click Confirm.

Your blueprint is now created! 

Add fields to a blueprint

To add fields to your integration blueprint, follow these steps:

1. Select your blueprint from the list.
2. Navigate to the Integration blueprint fields tab > click on Add an integration blueprint field.
3. Enter a name and description for the field.

4. Choose whether the mapping should be required and click Confirm.

   NOTE If mapping is required, the field must be mapped to a data field in the playbook. This is useful when the integration depends on specific information to function properly.

The field is now created. Repeat these steps to add all the fields you need.

Create custom API tokens

This is where you can create and manage your custom API tokens. To generate a new API token, follow these steps:

1. Click Generate new token.
2. Enter a name for the token.
3. Click Confirm.

Once confirmed, Oneflow will generate your API token. The token is only displayed once, so make sure to copy and store it in a secure location.

Webhooks

This section allows you to add and manage your custom webhook URLs in Oneflow, as well as view existing webhooks.

To create a new webhook, follow these steps:

1. Click Create webhook.
2. Enter the webhook URL and click Test to verify that it is valid.
3. (Optional) Add a signing key for additional security.
4. Click Confirm.

🔗Click Here to learn more about Playbooks