Trigger Node
The Trigger Node is the foundational node in any workflow. It serves as the entry point for the workflow and is required to configure inputs before proceeding with other workflow nodes. This documentation outlines how to configure and use the Trigger Node effectively.
Purpose of the Trigger Node
The Trigger Node allows you to define the initial input attributes required for the workflow. These attributes can come from either:
Custom Attributes: Manually created attributes.
Attribute Library: Predefined attributes available in your environment.
Key Features:
Input Attribute Definition:
Add input attributes to the workflow from both custom attributes and the attribute library.
These attributes act as variables or parameters that are passed into the workflow for further processing.
Testing Configuration:
Test the configured attributes directly within the Trigger Node to ensure they function correctly.
Workflow Triggering:
The Trigger Node enables workflows to be executed via external triggers such as APIs or webhooks.
Each workflow’s triggering mechanism is unique to its configured Trigger Node.
Steps to Configure the Trigger Node
Add Input Attribute
Create or select the workflow where you want to add a Trigger Node.
Open the Trigger Node configuration panel.
Define the input attributes:
From Custom Attributes:
Click on the Custom Attribute tab.
Add a new custom attribute by specifying its name, type, and default value (if required).
From Attribute Library:
Click on the Attribute Library tab.
Search for existing attributes and select the ones you want to add.
Save the configuration.
Configure the Settings for the Trigger Node
Go to the Settings tab to configure authentication, trigger method, and testing parameters.
Here you'll be able to see options like these:
1. Authentication:
From this section you can set the authentication for the API of the workflow. To enable it follow these steps:
Select Authentication Type:
Private: Requires API key authentication (recommended for production)
Public: No authentication required
Configure API Key (if Private selected):
Enter your nected-api-key value (format: XXXX-XXXX-XXX)
Trigger Configuration:
Here you can configure the trigger nodes
Set Status: Toggle to enable/disable the workflow trigger
Choose Trigger Method:
API: REST API endpoint triggering
Webhook: Webhook-based triggering
Response Caching: Enable to cache responses for better performance.
Base URL and Testing
Copy Base URL: Use the auto-generated endpoint URL for integration. The
format is:
https://nected-XX.nected.io/nected/workflow/{workflow-id}
Configure Body Parameters:
Set testing environment (default: "staging")
Define sample request parameters matching your input attributes:
Trigger the Workflow via API/WebHook
To trigger the workflow programmatically, the Trigger Node supports the following methods:
You can trigger the workflow by sending API requests. For detailed instructions and examples, visit the documentation page: Trigger Workflow via API
Workflows can also be triggered using webhooks. For complete steps on configuring and using webhooks, visit: Trigger Workflow via Webhook.
Conclusion
The Trigger Node serves as the essential foundation for every workflow in Nected. By properly configuring input attributes, authentication settings, and testing parameters, you establish a reliable entry point that enables seamless workflow execution through APIs or webhooks. Once configured, your workflow becomes accessible for integration with external systems and applications, providing the flexibility to process dynamic inputs while maintaining security and performance standards.
Last updated