List to Data Plugin
Arqam Saleem
Last Update 2 years ago
The List to Data Plugin is an action-only plugin that enables seamless data transfer from your app to an external API by converting lists into structured data objects. This plugin allows you to configure up to three key-value fields, making it easy to send batched or structured data using a secure, token-based API connection. Ideal for applications requiring bulk data transfers, dynamic updates, or custom data mapping, the List to Data Plugin brings flexibility and efficiency to data integration tasks.
Description:
The List to Data Plugin simplifies the process of sending data from lists in your app to an external API. With three customizable key fields, this action-based plugin is designed to support flexible data configurations, secure token authentication, and dynamic, real-time data delivery. Perfect for applications requiring efficient data exchange, it provides a straightforward solution for sending data in bulk with minimal setup.
Features:
Token-based Security:
- Utilize a secure access token for authentication, protecting data integrity and ensuring secure data handling.
Customizable Key Fields:
- Configure up to three key fields to match your data with the API’s expected format, giving you flexibility to handle different data structures.
Bulk Data Management:
- Send data in bulk from lists, ideal for applications requiring structured data transfers.
Plugin Actions and Setup
Action: create_a_list_of_things
- Parameters:
- Data API URL: The URL endpoint of the external API to which data will be sent.
- Data Token: The access token for API authentication.
- Field Mapping for Custom Data:
- Data Type: A specific data type or label if required by the API.
- Field Key 1: Primary key for Required by the Action to setup a proper call.
- Field 1 Values: Set of Values used against Field Key 1, Required.
- Field Key 2: Secondary key, optional.
- Field 1 Values: Set of Values used against Field Key 2, Optional.
- Field Key 3: Tertiary key, optional.
- Field 1 Values: Set of Values used against Field Key 3, Optional.
- Response Handling:
- On Success: Returns a success message confirming data receipt.
- On Error: Provides an error message for troubleshooting failed data transmissions.
Setup Instructions
Step-by-Step Guide to Using the Plugin
Enable API Access and Generate Access Token:
- Start by setting up API access in the external service and generating a secure access token.
- Copy this token for use in your plugin parameter configuration.
Configure Action in Workflow:
- Go to the workflow where data transmission is needed and select the create_a_list_of_things action from the List to Data Plugin.
Enter API URL and Access Token:
- Paste the external API URL into the Data API URL field.
- Enter your access token in the Data Token field to authenticate requests.
Map Field Keys with List Data:
- Define up to three field keys to structure data sent to the API. Each field corresponds to a list in your app and will be paired with its matching key for transmission:
- Field Key 1 (required)
- Field Key 2 and Field Key 3 (optional)
Trigger the Action:
- Run the workflow to trigger the create_a_list_of_things action.
- Confirm data is received by the API and troubleshoot if any errors are returned.