Skip to main content

Flexmail Data Source

The Flexmail connector enables you to ingest data from your Flexmail email marketing account, including contacts, campaigns, segments, interests, and webhook event types. Follow the instructions below to create a new data flow that ingests data from a Flexmail source in Nexla.
flexmail_api.png

Flexmail

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Flexmail connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Flexmail instance, and click Next; or, create a new Flexmail credential for use in this flow.

  3. In Nexla, Flexmail data sources can be created using pre-built endpoint templates, which expedite source setup for common Flexmail endpoints. Each template is designed specifically for the corresponding Flexmail endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Flexmail sources can also be configured manually, allowing you to ingest data from Flexmail endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Flexmail endpoints. Each template is designed specifically for the corresponding Flexmail endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Webhook Events

This endpoint retrieves a complete list of all available webhook event types in Flexmail. Use this endpoint when you need to discover which events can trigger webhook notifications in your Flexmail account, such as contact subscriptions, unsubscribes, or campaign interactions.

  • This endpoint requires no additional parameters. Once selected, Nexla will automatically fetch all available webhook event types from the Flexmail API at https://api.flexmail.eu/webhook-events.
  • The results are useful for understanding which event types are available when registering webhooks using the Create Webhook destination endpoint.

For more information about Flexmail webhook events and how they work, refer to the Flexmail Webhooks API documentation.

Get a contact

This endpoint retrieves detailed information for a single Flexmail contact by their unique contact ID. Use this endpoint when you need to fetch the full profile of a specific contact, including their email address, custom fields, and subscription status.

  • Enter the unique numeric identifier of the contact you want to retrieve in the Id field.

    • Contact IDs can be found via the Flexmail application interface or by querying the Flexmail API directly.
    • This field is optional — if left blank, the endpoint URL will be incomplete and the request may fail. Ensure a valid contact ID is provided before testing.

For additional details on Flexmail contact fields and attributes, refer to the Flexmail Contacts API documentation.

Get an interest

This endpoint retrieves details for a single Flexmail interest category by its unique ID. In Flexmail, interests are topic groups or mailing lists that contacts can subscribe to, allowing marketers to segment their audience based on stated preferences.

  • Enter the unique numeric identifier of the interest you want to retrieve in the Id field.

    • Interest IDs can be found in your Flexmail account under the interests management section, or by querying the Flexmail API.
    • This field is optional — ensure a valid interest ID is entered before testing to receive accurate results.

For additional details on Flexmail interests, refer to the Flexmail Interests API documentation.

Get Campaign

This endpoint retrieves the details of a single Flexmail campaign by its unique campaign ID. Use this endpoint when you need to access configuration, content, or metadata for a specific email campaign, such as its subject line, sender details, or scheduled send time.

  • Enter the unique numeric identifier of the campaign you want to retrieve in the Id field.

    • Campaign IDs can be found in your Flexmail account under the campaigns section, or via the Flexmail API.
    • This field is optional — provide a valid campaign ID before testing to receive complete campaign details.

For additional details on Flexmail campaigns, refer to the Flexmail API documentation.

Get Segment

This endpoint retrieves details for a single Flexmail segment by its unique ID. Segments in Flexmail are filters on your contact database that define a specific group of contacts based on criteria such as language, interests, campaign behavior, or custom field values.

  • Enter the unique numeric identifier of the segment you want to retrieve in the Id field.

    • Segment IDs can be found in your Flexmail account under the segments management section.
    • This field is optional — provide a valid segment ID before testing to receive accurate segment details.

For additional details on Flexmail segments, refer to the Flexmail Segments API documentation.

List contacts targeted by or interacted with a campaign

This endpoint retrieves the list of contacts associated with a specific campaign — including recipients, openers, clickers, and other interaction groups. Use this endpoint when you need to analyze which contacts were targeted by a campaign or how they interacted with it.

  • Enter the unique numeric identifier of the campaign in the Id field (Campaign ID).

    • This parameter is required. The campaign ID can be found in your Flexmail account under the campaigns section.
    • The response data is extracted from the $.data[*] path, meaning each contact record in the returned array will be treated as an individual record in Nexla.

This endpoint is useful for building audience lists for re-engagement campaigns or for analyzing campaign reach. For additional details, refer to the Flexmail API documentation.

Retrieve performance statistics for a campaign

This endpoint retrieves performance statistics for a specific Flexmail campaign, including opens, clicks, bounces, and unsubscribes. Use this endpoint when you need to analyze the effectiveness of a campaign and track key engagement metrics.

  • Enter the unique numeric identifier of the campaign in the Id field (Campaign ID).

    • This parameter is required. The campaign ID can be found in your Flexmail account under the campaigns section.
    • The response provides a single statistics object for the campaign, including aggregate counts for opens, clicks, bounces, and unsubscribes.

Campaign statistics are useful for reporting dashboards and performance analysis. For additional details, refer to the Flexmail API documentation.

List all segments

This endpoint retrieves a paginated list of all contact segments defined in your Flexmail account. Use this endpoint when you need an overview of all available segments, for example to populate a segment picker or to audit your current segmentation setup.

  • This endpoint requires no additional parameters. Once selected, Nexla will automatically fetch all segments from https://api.flexmail.eu/segments.
  • The response data is extracted from the $.data[*] path, meaning each segment record in the returned array is treated as an individual record in Nexla.

For additional details on Flexmail segments, refer to the Flexmail Segments API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Flexmail data sources can be manually configured to ingest data from any valid Flexmail API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Flexmail sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Flexmail API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API — the most common method for Flexmail data sources
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Flexmail API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

All Flexmail REST API endpoints are hosted at https://api.flexmail.eu/. For a complete list of available endpoints and their URL patterns, refer to the Flexmail API documentation. Ensure the API endpoint URL is correct and accessible with your current credentials before saving.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for Flexmail APIs that accept date range parameters, such as filtering campaigns or contacts by creation date or modification date.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}. The Flexmail API typically expects dates in yyyy-MM-dd format.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to create Flexmail API endpoints that reference specific IDs, such as contact IDs, campaign IDs, or segment IDs retrieved from another Nexla data source.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when Flexmail API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, many Flexmail list endpoints return an array of records nested under a data key in the JSON response. By entering the path to this array (e.g., $.data[*]), you can configure Nexla to treat each element of the returned array as a separate record.

Path to Data is essential when Flexmail API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data[*] to access an array of records within a data object, or $ for the root-level object).
    Path to Data Example:

    If the Flexmail API response is in JSON format and includes a top-level array named data that contains the relevant records, the path to the response data would be entered as $.data[*]. For endpoints that return a single object (such as Get a Contact or Get Campaign), use $ to reference the root object.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, when a request call is used to fetch a list of Flexmail contacts or campaigns, the API response may include an array of records along with metadata such as a total count or pagination links. In this case, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving Flexmail API response context like total record counts or request timestamps that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for API versioning or content type specifications.

    You do not need to include the Authorization header or any other headers already present in the Flexmail credential. These are handled automatically by Nexla based on your credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Flexmail data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.