OmniFlow

Overview

This node integrates with the OmniFlow API to manage various CRM-related entities such as companies, contacts, campaigns, segments, and emails. It allows users to create, update, retrieve, delete, and manipulate these resources programmatically within n8n workflows.

Common scenarios where this node is beneficial include:

• Automating contact and company management by syncing data from other systems.
• Managing marketing campaigns by adding or removing contacts.
• Sending segment-targeted emails automatically.
• Organizing contacts into segments for targeted communication.
• Updating CRM records based on external triggers or events.

For example, a user could automate adding new leads from a web form into OmniFlow as contacts, assign them to specific campaigns, and send welcome emails without manual intervention.

Properties

Output

The node outputs JSON data representing the result of the performed operation on the selected resource. The structure varies depending on the resource and operation:

• For create and update operations, it returns the created or updated entity's details, often including all fields or a simplified version based on user selection.
• For get operations, it returns the requested entity's data.
• For getAll operations, it returns an array of entities, either limited or complete depending on parameters.
• For delete operations, it returns confirmation of deletion along with the deleted entity's data.
• For actions like adding/removing contacts to/from campaigns, segments, or companies, it returns the updated entity information.
• For sending emails or editing contact points/do-not-contact lists, it returns status or updated contact info.

If the user opts for simplified output, the node extracts and returns only the core fields (fields.all) of the entities.

The node does not output binary data.

Dependencies

• Requires access to the OmniFlow API.
• Needs either an API key credential or OAuth2 authentication configured in n8n.
• Uses internal helper functions to make HTTP requests to OmniFlow endpoints.
• No additional external dependencies beyond standard n8n environment.

Troubleshooting

• Invalid JSON error: When using JSON input parameters (e.g., for contact creation/update), invalid JSON strings will cause errors. Ensure JSON syntax is correct.
• API errors: If the OmniFlow API returns errors (e.g., invalid IDs, missing required fields), the node throws an error with the API message. Verify input parameters and credentials.
• Authentication failures: Incorrect or expired credentials will prevent API calls. Check that the API key or OAuth2 token is valid and has necessary permissions.
• Limit and pagination: When fetching multiple items, improper limit or pagination settings may cause incomplete data retrieval. Use returnAll option to fetch all items if needed.
• Continue on Fail: If enabled, the node will continue processing remaining items even if some fail, returning error messages in the output JSON.

Links and References

• OmniFlow API Documentation (example placeholder, replace with actual URL)
• n8n Documentation on Credentials
• n8n Node Development Guide