How to Add a Custom App as an action in Bit Flows

In this guide, I will explain how to create a custom action app in Bit Flows. The main goal is to show you the steps to build and set up a custom action app. For this example, we will create an app that sends Bit Form submission data to MailerLite to add a new subscriber.

After reading this guide, you will easily understand how to create and use custom action apps in Bit Flows for your automation needs. Once the setup is complete, data from a trigger like a Bit Form submission will be sent to the selected action, such as MailerLite, saving time and making your workflows smoother.

What is a Custom Action App in Bit Flows?

A Custom Action App in Bit Flows lets you create specific tasks that will be carried out in a workflow. An action is a task that happens after a trigger starts the workflow. With a custom action app, you can set up unique tasks to connect with any app or system you are using.

Choose the type of module you want to create. A trigger is what starts a workflow, and an action is a task done after the workflow starts. After creating your custom action, you can add it to a workflow to do things like send data, create records, or update details. This helps you easily automate tasks as per your needs.

Create Custom App in Bit Flows

First, go to Bit Flows Custom Apps and click on Create New App. A popup will appear.

Here, you can provide a name for your app, add a description, choose a logo, and even select a theme. Once done, click on the Create button.

Congratulations! You have successfully created a Custom App.

Add Custom Action in Bit Flows

Now, you need to create a module. These modules can either be a Trigger or an Action, and you can add as many triggers and actions as needed.

In Bit Flows, to create a Custom Action, click on Add Module. This will open a popup.

We want to create a Custom App based on a Action. So, for this module, we will select “Action.” After that, we need to configure the module for the Action.

Configure The Action

Here, you need to configure the action for your custom app. Start by setting a name for the action for easy identification, add a description.

Enable Authentication

By enabling “Enable Authentication,” you can set a default connection for this action, which will be used to authenticate the request. Authentication is the process of verifying the identity of a user or system to ensure secure communication. For example, you might use an API key, a token, or OAuth credentials to authenticate with an external service. During the flow setup, you also have the option to select other connections if needed.

If you already have a connection set up, you can choose it from the list. If not, click on the “Add” button to create a new connection. You will be prompted to provide the Connection Type and a Connection Name for the new setup.

For this example, we will create a subscriber in MailerLite. To do this, we need the MailerLite API key. So, we will choose “API Key” as the connection type. After that, you need to give a name for the connection.

Once you select the connection type, you will be asked to provide the key and its value. You will also need to specify where you want to add this key. In this case, we will add it in the header.

After entering the key and selecting where to add it, click on “Connect” to complete the connection. Finally, you can choose this connection for authentication in your workflow. This way, your action will be securely linked to MailerLite using the API key for creating a subscriber.

Request URL

Request URL refers to the endpoint of the external service or API you are trying to interact with in your custom action. It’s the address to which the request is sent, and it tells the system where to send the data or request. For example, if you are connecting to an API to create a subscriber, the Request URL will be the endpoint provided by the service for that action (like creating a subscriber in MailerLite).

Different HTTP Methods in API Requests:

When working with APIs, different HTTP methods are used to indicate the type of action you want to perform. Here’s a simple explanation of the common HTTP methods used in Bit Flows Custom Actions:

• GET: Retrieve data without changing anything.
• POST: Send data to create a new resource.
• PUT: Update an existing resource with new data.
• PATCH: Partially update an existing resource.
• DELETE: Remove a resource.

In Bit Flows Custom Action, the Request URL defines the API endpoint, and the HTTP method (GET, POST, PUT, PATCH, DELETE) defines the action you wish to perform with that endpoint.

For this example, we want to create a subscriber in MailerLite, so we will choose POST for the HTTP Method and enter the MailerLite subscriber creation URL.

Content Type

Content Type in Bit Flows specifies the format of the data being sent in an API request. It helps the server understand how to interpret the incoming data. While creating a custom action in Bit Flows, selecting the correct Content Type ensures proper communication between your app and the API.

Available Content Types:

1. JSON: Used for sending structured data in a lightweight and easy-to-read format. Commonly used with APIs.
   • Example: { "name": "John", "email": "[email protected]" }
2. Form-Data: Used for sending key-value pairs, often when uploading files or handling multipart data.
   • Example: Name: “John”, File: “resume.pdf”
3. Encoded Form-Data: Similar to Form-Data but sent in URL-encoded format.
   • Example: name=John&[email protected]
4. Text: For sending plain text without any specific structure.
   • Example: "This is a sample text message."
5. HTML: For sending HTML content.
   • Example: <p>Hello, this is an HTML message.</p>
6. XML: For sending data in XML format, commonly used in older APIs.
   • Example: <user><name>John</name><email>[email protected]</email></user>

By choosing the appropriate Content Type, you ensure that the API correctly understands and processes the data you are sending.

For this example, we will select JSON as the Content Type since it is widely used and easy to work with for structured data. However, you can choose the Content Type based on your specific requirements and the API’s preferences.

Headers

Headers are additional pieces of information sent with your API request to provide context or instructions to the server. They help define the request’s format, authentication details, and more.

When sending data to a platform, if the API documentation specifies any required headers, you must include them in your request. For instance, to create a subscriber in MailerLite, their documentation specifies adding the following headers:

• Content-Type: application/json
• Accept: application/json

These headers inform the server that the request body is in JSON format and that the response should also be in JSON.

To add a header, click on Add Header. This will add an input field where you can enter the key required for your selected platform.

Next, click on the settings icon in the right corner of the input field. Here, you can set a label for the header and define a default value.

If you need to delete a header, simply click on the delete icon next to the added header. This makes it easy to manage and update your headers as per your requirements.

QueryParams

Query Parameters (QueryParams) are key-value pairs appended to the URL of an API request to provide additional data or instructions to the server. These parameters are added after a ? in the URL and separated by &. They help refine or filter the request without changing the endpoint.

How to Use Query Parameters in Bit Flows?

Query parameters are used to send additional data in an API request URL. Here’s how to add and configure them in Bit Flows:

1. Adding a Query Parameter:
   • Click on the Add button.
   • An input field will appear where you can enter the key name for the parameter.
2. Configuring the Query Parameter:
   • Click on the settings icon next to the input field.
   • In the settings, you can:
     • Set a label to identify the parameter.
     • Choose the field type.
     • Define a default value for the parameter.
     • Make the field mandatory by checking the Make this field required option.

This ensures your API request is correctly structured and adheres to the requirements of your selected platform. Always refer to the platform’s API documentation for specific query parameter details.

Body

The Body is where you define the data payload to be sent in the API request. This is essential when working with HTTP methods like POST, PUT, or PATCH, where you need to provide data to create or update resources.

How to Use Body in Custom Action?

1. Add a Body Field:
   • Click on Add.
   • An input field will appear where you can define the key name for the body parameter.
2. Configure the Body Field:
   • Click on the settings icon next to the input field.
   • In the settings, you can:
     • Set a label for easy identification.
     • Choose the field type.
     • Provide a default value for the parameter.
     • Check Make this field required if it’s mandatory for the request.
3. Structure the Data:
   • The structure of the body depends on the Content Type you have selected (e.g., JSON, Form-Data).
   • For example, if you’re using JSON, the body will be sent in key-value format like:

{ "email": "[email protected]", "name": "John Doe" }Copy

For this demonstration, the email field is required in MailerLite. So, we will add a field in the body. You can also set a default email if needed, but for this example, we will not add any default value. Instead, we will map this email field in our workflow with the trigger. Remember, the fields you add in the body while setting up the custom action will be available for dynamic mapping with the trigger during the workflow setup.

Custom Request Body (Raw JSON)

In Bit Flows, the Custom Request Body (Raw JSON) feature allows you to define a custom JSON structure for sending data to the API endpoint. This is particularly useful when the API you’re working with requires a specific JSON format for the request body. Instead of filling individual fields, you can directly provide the JSON structure as needed.

Key Points:

1. Customised Data Structure: You can create and send complex JSON objects with nested fields, arrays, or specific formatting that an API requires.
2. Flexibility: Ideal for advanced use cases where the default form-based body setup doesn’t suit your needs.
3. Dynamic Mapping: You can include placeholders or variables in the JSON structure that will dynamically map with the trigger or other workflow data during execution.

If you want to add a Custom Request Body (Raw JSON), you need to enable it first. Once enabled, a text area will appear where you can write your JSON code. Simply enter the required JSON structure directly into this area to customise the request body as per your API’s requirements.

Once you have finished configuring the Custom Action, click on the Save button to save your changes. After saving, your custom action will appear in the list of available actions under your custom app.

Test The Custom Action App

After creating an action in your custom app, let’s see how to use the custom action app. Open an existing workflow or create a new one. For this demonstration, we already have a workflow named “BitFormToMailerLite,” and we will add our custom action app to it.

First, navigate to the Flows section and open the flow. Add your action, and this will open a popup. Select your created custom app as the action, and then choose the custom action event. For this example, we select MailerLite Create Subscriber.

Now, we need to configure the MailerLite Create Subscriber action. When you select MailerLite, you will see the email field, which we had added in the body while creating the custom action. You need to map this field with the email field from the trigger (Bit Form). Once done, close the popup.

Finally, click on Test Flow Once to test the action. Ensure that the action is triggered, check the logs, and verify that the data is successfully sent to MailerLite to create a new subscriber.