API by FlowMattic

The API (Application Programming Interface) is a set of protocols, routines, and tools that enable software applications to interact with one another. APIs allow data sharing and the execution of functions between different systems, making them essential for integrating third-party tools, services, or data into existing applications. APIs are widely used across various platforms like web applications, mobile apps, and more.

In FlowMattic, the API module allows users to interact with external APIs, enabling data exchange between different systems and automating a wide range of tasks. With this module, users can perform HTTP/HTTPS actions such as GET, POST, PUT, DELETE, and PATCH to retrieve, update, or delete data across different platforms. The FlowMattic API module is particularly useful for automating processes like data synchronization, report generation, and data entry between systems.

Key Features of the API Module

• Perform HTTP/HTTPS requests (GET, POST, PUT, DELETE, PATCH).
• Retrieve and send data between different systems.
• Supports custom headers and parameters for API requests.
• Multiple authentication options including Basic, Bearer Token, and the newly added Connects for pre-authenticated access.

---

Step-by-Step Instructions for Using the FlowMattic API Module

To use the API module in a FlowMattic workflow, follow these steps:

1. Create a New Workflow

• Log into your WordPress dashboard and and navigate to the FlowMattic Dashboard.
• Click the “New Workflow” button to start creating a new workflow.

2. Select the API Integration

• In the workflow builder, click on the “Choose Application” button.
• From the available options, select “API Integration”.

3. Choose the Action Event

Once you’ve selected API Integration, choose the type of action event (HTTP request) that you want to perform:

• GET: Retrieves data from the API endpoint.
• POST: Creates new data in the API endpoint.
• PUT: Updates existing data in the API endpoint.
• DELETE: Deletes data from the API endpoint.
• PATCH: Partially updates existing data in the API endpoint.

4. Enter the API Endpoint URL

• Provide the API endpoint URL where the action will be performed. The endpoint URL typically consists of the protocol (HTTP/HTTPS), domain name, and the specific path to the API resource.
• The API documentation for the service you’re integrating with will specify the correct endpoint URL.

5. Authentication Option

To ensure secure communication, most APIs require authentication. FlowMattic supports multiple authentication methods:

• Basic Authentication: A standard method where the username and password are encoded and passed in the request.
• Bearer Token Authentication: Uses an API token or key provided by the API provider.
• Connects: This option allows users to leverage pre-authenticated API access data through FlowMattic Connects. If you’ve already set up API connections in FlowMattic Connects, you can select this option to use the stored credentials for authentication, making the setup process faster and more secure.
• How to Use Connects: If you’ve previously configured an API connection in the FlowMattic Connects section, simply select the appropriate connection, and the stored credentials will be used automatically for the API request, removing the need to input the authentication details again.
• When to Use Connects: This option is particularly useful for APIs that are used frequently across multiple workflows, allowing you to centralize your API authentication management.

6. Set Custom Headers (Optional)

Some APIs require specific headers, such as Content-Type or custom authentication tokens. In FlowMattic, you can define these custom headers as needed:

• Enable the Custom Headers option.
• Add the required headers by specifying the Key (header name) and Value (header content).

7. Add Parameters (Optional)

If your API request requires parameters (such as query parameters or a request body), you can configure them in the Parameters section:

• Enable the Parameters option.
• Define the necessary Key (parameter name) and Value (parameter content) pairs.

8. View the API Response

After configuring the API step, you can view the API response in the step output:

• FlowMattic captures the full API response, including all data returned by the endpoint.
• By default, only the parent-level keys are shown in the step output. However, all the data is captured in the background, and you can expand it as needed in subsequent steps.

9. Conditional Execution

FlowMattic allows you to configure conditional execution for the API module. This means you can specify conditions under which the API request will be executed. Conditional execution can make your workflows more efficient by preventing unnecessary API requests:

• Enable the Conditional Execution option and set the conditions based on the response from previous steps.

10. Save and Test the API Request

• Once you’ve configured all the necessary fields, click “Save & Test Action”.
• The system will send a live request to the API, and the response will be displayed in the output. This allows you to verify that your API request is functioning as expected.

11. Finalize the Workflow

• After successfully testing the API step, click “Save and Continue” to finalize the workflow.
• The API step is now ready to be executed as part of your workflow.

---

Conclusion

The API module in FlowMattic offers a powerful and flexible way to integrate external applications into your automated workflows. Whether you’re retrieving data, sending updates, or deleting information, the API module enables seamless communication between systems via HTTP/HTTPS protocols.

With the new Connects feature, managing authentication for your APIs is easier than ever, allowing you to reuse pre-authenticated credentials across multiple workflows. Combined with custom headers, parameters, and conditional execution, FlowMattic provides full control over API requests and ensures they are configured to suit your needs.

By following this step-by-step guide, you can quickly and easily set up API integrations and improve the efficiency of your automated workflows, helping to streamline your business processes.