API Configuration

The API Configuration feature in Ownchat Flow Builder allows you to integrate external systems by making API requests within workflows.

This enables businesses to:

• Fetch external data

• Send data to third-party systems

• Integrate backend services (CRM, ERP, etc.)

• Automate workflows based on API responses

Overview

API Configuration enables workflows to interact with external systems using configured API connections and data exchange actions.

Workflow Flow

Trigger Event ↓ API Action (Data Exchange) ↓ API Request Sent ↓ Response Received ↓ Success / Failure Navigation ↓ Next Workflow Step

Prerequisites

Required Access

• Ownchat account

• Flow Builder access

• API endpoint details

Required API Information

• API URL

• Authentication details

• Request/response structure

Adding API Configuration Action

Step 1: Add Action

Open the Flow Builder. After creating the flow, you can set the API connection in the footer section of the Flow Builder.

Step 2: Edit Action

1. Click Edit Action to configure API settings

Step 3: Select Action Type

1. Select data_exchange from the dropdown

data_exchange

This defines the action as an API integration step.

Configuring API Integration

Step 1: Select or Create API Integration

1. Click the dropdown to Select or Create API Integration

1. Choose an existing configuration OR create a new one

Step 2: Create New API Configuration

1. Click:

Create New Config

This allows you to create a new API setup.

Managing API Connections

Step 1: Open API Connections

Click:

API Connections

This section is used to manage all API integrations.

Step 2: Add New Connection

Click:

Add Connection

Step 3: Enter Connection Details

Title

Enter a descriptive name:

Customer API

URL

Enter the API endpoint:

https://api.example.com/data

Step 4: Save Connection

Click:

Create

The API connection will be saved successfully.

Step 5: View Created Connections

The created API connections will be listed under:

API Connections

Configuring API Action Details

Step 1: Enter API Name

Enter a title for the API:

Fetch API Data

Configuring Success Navigation

Step 1: Select Success Screen

1. Select a screen from the dropdown

1. This defines where the workflow navigates after a successful API call

Example:

First Screen

Configuring Failure Navigation

Step 1: Select Failure Screen

1. Select a screen from the dropdown

1. This defines what happens when the API fails

Example:

Sample Screen

Adding API Data

Step 1: Add API Data

Click:

Add API Data

This integrates external data into the workflow.

Step 2: Confirmation Message

A popup will appear:

API details created successfully

Step 3: Select API Configuration

Select the created API from the dropdown

Example:

Sample

Saving API Configuration

Step 1: Update Component

Click:

Update Component

This saves all API configuration changes.

Using API Response in Workflow

After configuration, the API response can be used in:

• Messages

• Conditions

• Variables

Example:

{{api_response.data}}

Adding Conditional Logic (Optional)

Step 1: Add IF Statement

1. Click Add Action

2. Select If Statement

Step 2: Configure Condition

Variable

api_response.status

Data Type

String

Operator

is

Value

success

Disable Dynamic Value if using a static condition.

Verifying Configuration

Before publishing, verify:

• API connection

• Endpoint URL

• Success screen mapping

• Failure screen mapping

• API data integration

Publishing the Workflow

Click:

Publish

The workflow will become active.

Testing the API Configuration

Steps

1. Trigger the workflow

2. Verify API request execution

3. Check success navigation

4. Check failure navigation

5. Validate API response usage

Troubleshooting

API Not Working

Possible causes:

• Incorrect API URL

• Connection not created

• API not selected

Navigation Not Working

Check:

• Success screen configuration

• Failure screen configuration

API Data Not Available

Check:

• API data mapping

• API selection in dropdown

Best Practices

Use Descriptive Names

Example:

Customer API Integration

Verify API Connections

Always confirm the API connection is created and selected correctly.

Configure Proper Navigation

Set both success and failure screens to avoid workflow breaks.

Test API Before Deployment

Ensure the API works correctly before integrating.

Summary

The API Configuration feature allows workflows to integrate external systems using API connections and data exchange actions.

Workflow process:

1. API connection is created

2. Data exchange action is configured

3. API request is executed

4. Response is processed

5. Workflow navigates based on success or failure

This enables powerful real-time integrations and automation in Ownchat Flow Builder.