FlowMattic

https://support.flowmattic.com/kb
Admin
FlowMattic is a platform for creating workflows and automating tasks by connecting various...
Tokens:167,431
Snippets:1,894
Trust Score:9.2
Update:8 months ago
Show doc for...
Tokens:
Raw
### API Tool Examples: GET, POST, PUT Requests

Source: https://support.flowmattic.com/kb/article/91

Illustrates common API request patterns including GET for retrieving data, POST for creating resources, and PUT for updating resources. Each example specifies the endpoint, HTTP method, parameters, and authentication requirements.

```text
Endpoint: https://api.openweathermap.org/data/2.5/weather
Method: GET
Parameters: city, api_key, units
Headers: None required
```

```text
Endpoint: https://api.crm.com/v1/contacts
Method: POST
Parameters: name, email, phone, company
Headers: {"Authorization": "Bearer token", "Content-Type": "application/json"}
```

```text
Endpoint: https://api.ecommerce.com/products/{product_id}
Method: PUT
Parameters: product_id, name, price, description
Authentication: FlowMattic Connect (OAuth2)
```

--------------------------------

### Example: Simple User Lookup Tool for FlowMattic MCP Server (PHP)

Source: https://support.flowmattic.com/kb/article/89

This comprehensive example demonstrates how to create a 'Get User by ID' tool for the FlowMattic MCP Server. It includes the PHP function `my_plugin_get_user_by_id` that retrieves user data and handles cases where the user is not found. The example also shows how to register this tool with the FlowMattic MCP Server.

```php
/**
 * Function to get user by ID and return user data.
 *
 * @param int $user_id The WordPress user ID.
 * @return array The user data or an error message if the user does not exist.
 */
function my_plugin_get_user_by_id( $user_id ) {
    // Get user
    $user = get_userdata( $user_id );

    // Check if user exists - Example of error reporting to MCP tool
    if ( ! $user ) {
        return array(
            'error' => 'User not found.',
        );
    }

    // Get the user data
    $user_data = (array) $user->data;
    $user_fields = array();

    foreach ( $user_data as $key => $value ) {
        // Skip empty values
        if ( empty( $value ) ) {
            continue;
        }
        $user_fields[ $key ] = $value;
    }

    // Return user fields - can be string or array
    return $user_fields;
}

// Register the tool
if ( function_exists('flowmattic_add_mcp_tools') ) {
    $tools = array();
    
    $tools[] = array(
        'name'          => 'Get User by ID',
        'description'   => 'Retrieve a user profile details by their WordPress user ID.',
        'function_name' => 'my_plugin_get_user_by_id',
        'parameters'    => array(
            'user_id',
        ),
    );

    flowmattic_add_mcp_tools( 'User Management Plugin', $tools );
}
```

--------------------------------

### Python Example: Integration Management Task with FlowMattic

Source: https://support.flowmattic.com/kb/article/88/openai-api-and-flowmattic-mcp-server-integration-guide

Python code snippet demonstrating the use of FlowMattic and OpenAI for integration management. This example shows how to create a new workflow connecting a contact form to an email marketing service and Slack.

```python
# Manage integrations through natural language
instruction = "Create a new FlowMattic workflow that connects my contact form to my email marketing service and Slack notifications"

response = integration.execute_flowmattic_task(instruction)
```

--------------------------------

### Python Example: Multiple Tool Integration for FlowMattic

Source: https://support.flowmattic.com/kb/article/88/openai-api-and-flowmattic-mcp-server-integration-guide

A Python list demonstrating how to configure multiple tools, including FlowMattic and other services, for use with the OpenAI API. This enables complex workflows involving different platforms.

```python
tools = [
    {
        "type": "mcp",
        "server_label": "flowmattic",
        "server_url": "{{flowmattic_mcp_server}}",
        "require_approval": "never",
        "headers": {"Authorization": "Bearer FLOWMATTIC_TOKEN"}
    },
    {
        "type": "mcp",
        "server_label": "other_service",
        "server_url": "https://other-service.com/mcp",
        "require_approval": "auto",
        "headers": {"Authorization": "Bearer OTHER_TOKEN"}
    }
]
```

--------------------------------

### CSV File Requirements Example

Source: https://support.flowmattic.com/kb/article/100/flowmattic-tables-csv-import-guide

Demonstrates the basic structure and formatting for a CSV file to be imported. It shows column headers and example data rows, highlighting the use of double quotes for fields containing commas.

```csv
id,customer_name,email,registration_date,status
1,"John Doe",john@example.com,2025-01-15,active
2,"Jane Smith",jane@example.com,2025-01-16,pending
```

--------------------------------

### API Tool GET Request Example (Weather)

Source: https://support.flowmattic.com/kb/article/91/how-to-add-mcp-tools-in-flowmattic-mcp-server

Demonstrates the configuration for a GET request to a weather API. It specifies the endpoint, HTTP method, and required parameters.

```text
Endpoint: https://api.openweathermap.org/data/2.5/weather
Method: GET
Parameters: city, api_key, units
Headers: None required
```

--------------------------------

### Data Storage Conversion (Bytes to Gigabytes)

Source: https://support.flowmattic.com/kb/article/105/unit-converter-by-flowmattic---complete-guide

Example for converting data storage units from bytes to gigabytes (GB), useful for monitoring storage usage. Expects the byte value as a dynamic input.

```json
{
  "value": "{storage.used_bytes}",
  "from_unit": "bytes",
  "to_unit": "GB"
}
```

--------------------------------

### Python Example: Data Analysis Task with FlowMattic

Source: https://support.flowmattic.com/kb/article/88/openai-api-and-flowmattic-mcp-server-integration-guide

Python code snippet showcasing how to perform data analysis using FlowMattic and OpenAI. This example involves analyzing e-commerce performance data and generating a monthly report.

```python
# Analyze FlowMattic data and generate reports
instruction = "Analyze the performance data from my e-commerce workflows in FlowMattic and create a monthly performance report"

response = integration.execute_flowmattic_task(instruction)
```

--------------------------------

### Valid URL Examples for Link Shortener

Source: https://support.flowmattic.com/kb/article/113/link-shortener

These examples demonstrate valid URL formats that can be used with the Link Shortener integration. They include URLs with various parameters, subdirectories, and affiliate tracking codes, all requiring the protocol prefix.

```text
https://example.com/products/category/subcategory/item-name?utm_source=email&utm_campaign=spring-sale
https://yourstore.com/blog/2024/01/15/ultimate-guide-to-product-reviews-and-comparisons
https://affiliate-program.com/tracking/refer?id=12345&campaign=Q1-2024&source=website
```

--------------------------------

### Python Example: Workflow Automation Task with FlowMattic

Source: https://support.flowmattic.com/kb/article/88/openai-api-and-flowmattic-mcp-server-integration-guide

Python code snippet illustrating the execution of a workflow automation task using FlowMattic and OpenAI. This example focuses on checking for new submissions and triggering an email workflow.

```python
# Trigger a FlowMattic workflow based on conditions
instruction = "Check if there are any new contact form submissions in the last hour, and if so, trigger the welcome email workflow"

response = integration.execute_flowmattic_task(instruction)
```

--------------------------------

### Google Maps API Example - GET Request

Source: https://support.flowmattic.com/kb/article/57/use-flowmattic-api-module-for-connecting-applications-via-api

Demonstrates how to retrieve distance information between two locations using the Google Maps API via a GET request within the FlowMattic API module. Requires a Google Maps API key.

```text
https://maps.googleapis.com/maps/api/distancematrix/json?origins=Toronto&destinations=Montreal
```

--------------------------------

### PHP Function Tool Example for FlowMattic MCP Server

Source: https://support.flowmattic.com/kb/article/91/how-to-add-mcp-tools-in-flowmattic-mcp-server

Demonstrates how to create PHP functions that can be integrated as tools within the FlowMattic MCP Server. Includes examples for both individual parameters and array-based parameter handling, showcasing data retrieval and processing logic.

```php
// Example function that gets user data
function get_user_details_by_id($user_id) {
    // Validate input
    if (empty($user_id) || !is_numeric($user_id)) {
        return array('error' => 'Invalid user ID provided');
    }
    
    $user = get_userdata($user_id);
    
    if (!$user) {
        return array('error' => 'User not found');
    }
    
    return array(
        'success' => true,
        'data' => array(
            'id' => $user->ID,
            'username' => $user->user_login,
            'email' => $user->user_email,
            'display_name' => $user->display_name,
            'role' => $user->roles[0] ?? 'subscriber'
        )
    );
}

// Array-based function example
function process_user_data($input_array) {
    $user_id = $input_array['user_id'] ?? '';
    $action = $input_array['action'] ?? '';
    
    // Process based on action
    switch ($action) {
        case 'get_posts':
            return get_user_posts($user_id);
        case 'get_meta':
            return get_user_metadata($user_id);
        default:
            return array('error' => 'Invalid action specified');
    }
}
```

--------------------------------

### Frequency Conversion Example

Source: https://support.flowmattic.com/kb/article/105/unit-converter-by-flowmattic---complete-guide

Demonstrates converting between different frequency units like Hertz, Kilohertz, Megahertz, Gigahertz, RPM, and BPM. Requires specifying the value, from unit, and to unit.

```json
{
  "status": "success",
  "converted_value": 60000,
  "from_unit": "hz",
  "to_unit": "rpm",
  "original_value": 1
}
```

--------------------------------

### FlowMattic Custom Headers Configuration

Source: https://support.flowmattic.com/kb/article/88/openai-api-and-flowmattic-mcp-server-integration-guide

Example of configuring custom headers for FlowMattic tool integration. This allows for passing authentication tokens and other necessary request headers.

```json
{
    "headers": {
        "Authorization": "Bearer YOUR_TOKEN_HERE",
        "X-Custom-Header": "custom-value",
        "User-Agent": "MyApplication/1.0"
    }
}
```

--------------------------------

### PHP Function and Parameter Testing Examples

Source: https://support.flowmattic.com/kb/article/91/how-to-add-mcp-tools-in-flowmattic-mcp-server

Demonstrates how to test individual PHP functions and parameter handling with various inputs. These snippets can be run in a WordPress environment or via WP-CLI for isolated testing before integration.

```php
// Test in WordPress admin or via WP-CLI
$result = your_function_name( 'test_value' );
var_dump( $result );
```

```php
// Test different parameter combinations
$test_cases = array(
    array( 'user_id' => '1' ),
    array( 'user_id' => 'invalid' ),
    array(), // Missing parameters
);

foreach ( $test_cases as $params ) {
    $result = your_function( $params );
    echo "Input: " . json_encode( $params ) . "\n";
    echo "Output: " . json_encode( $result ) . "\n\n";
}
```
Tokens:
Raw