Creating Custom App for your application using APIs
Creating a custom app within FlowMattic provides a powerful way to integrate external applications that are not already available in the FlowMattic integrations library. This guide outlines the steps required to create a custom application using APIs in FlowMattic, enabling you to extend its functionality and streamline your workflows.
Steps to Create a Custom App
1. Navigate to the Custom Apps Section
Begin by accessing the WordPress dashboard. From there, locate and open the FlowMattic -> Custom Apps
section to manage or create new custom applications.
2. Create a New Application
To initiate the creation of a custom application:
- Click on the
Create New App
button. - In the
App Info
tab, provide the necessary details such as the name and description of the app. - Once all required fields are completed, click on the
Save App Info
button to finalize the creation of your custom application.
3. Add Actions to Your Custom Application
Actions are the tasks your custom app can perform. To define these actions:
- Navigate to the
Actions
tab within your custom app. - Actions may include tasks like creating, updating, or managing specific data, depending on your requirements.
4. Configure a New Action
To set up a new action for your custom app:
- Click on the
Create New Action
button. This will open a configuration popup. - In the popup, you will find the following fields to configure:
- Action Name: Provide a meaningful and descriptive name for the action (this is a mandatory field).
- Action Description: Optionally, include a brief description of what the action does.
- Action Event API Configuration: Specify the API endpoint, body, and header parameters. Alternatively, you can import a cURL request for faster setup.
5. Configure Action Settings in Detail
Use the available configuration tabs to define the action’s settings:
- Basic:
- Set the API Endpoint, HTTP Method (e.g., GET, POST, PUT, DELETE), and Request Content Type (e.g., JSON, XML, Form Data).
- Headers:
- Enable and add any headers required by the API you are integrating with.
- Body:
- Enable Request Body Parameters and input the necessary fields.
- If the API requires custom JSON or XML, you can input it in the
Request Body (Raw JSON/XML)
section. - Use placeholders (e.g.,
{{title}}
,{{content}}
) to dynamically reference parameters within your workflow.
6. Save the Configured Action
Once you have completed configuring the action, click the Save Action
button to store the action within your custom app.
7. Use the Custom Application in Workflows
After completing the setup, your custom app will be available for use in FlowMattic workflows. You can now integrate it seamlessly into your automation processes.
Importing cURL Requests for Quick API Configuration
FlowMattic simplifies the process of configuring actions by allowing you to import cURL requests directly. Here’s how you can leverage this feature:
- Open your custom app and navigate to the
Actions
tab. - Click on the
Create New Action
button to add a new action. - In the action configuration popup, select the
Import cURL Request
button. - Paste the cURL request into the provided text area and click the
Process Request
button. - FlowMattic will parse the cURL request and automatically set the API endpoint, body, and header parameters.
- Review the parsed configuration and make any necessary adjustments.
- After verifying the details, click the
Save Action
button to save the action.
It is recommended to test the action after saving to ensure that it functions as expected. Using the cURL request import feature can significantly reduce setup time, especially when integrating with APIs that provide example cURL requests in their documentation. Tools like Postman can also be used to test APIs and generate cURL requests for import into FlowMattic.
Additional Tips for Success
- Always have the API documentation for the application you are integrating at hand. This will help you understand the required endpoints, parameters, and authentication methods.
- Thoroughly test API endpoints and parameters before finalizing your configuration to avoid errors during execution.
- Use clear and descriptive names for your actions. This will make it easier to manage and organize your workflows within FlowMattic.
By following these detailed steps, you can effectively extend the capabilities of FlowMattic to connect with virtually any application that supports APIs. This flexibility allows you to create robust and customized automation workflows tailored to your specific needs. If you encounter any issues or require assistance while creating your custom app or importing cURL requests, do not hesitate to reach out to FlowMattic support for guidance. We are always here to help!