IKAS Trigger icon

IKAS Trigger

Starts the workflow when IKAS events occur

Overview

This node acts as a trigger for workflows based on events occurring in the IKAS platform, an e-commerce or store management system. It listens for specific IKAS events such as customer creation, order updates, product changes, and stock modifications. When one of these events happens, the node activates the workflow, passing along relevant event data.

Common scenarios where this node is beneficial include:

  • Automating follow-up actions when a new customer registers.
  • Syncing inventory systems when stock levels change.
  • Notifying teams or external systems when orders are created or updated.
  • Tracking customer favorite products to personalize marketing.

For example, you could use this node to start a workflow that sends a welcome email whenever a "Customer Created" event occurs or update a CRM system when an "Order Updated" event triggers.

Properties

Name Meaning
Event The specific IKAS event that triggers the workflow. Options include:
- Customer Created: Triggers when a new customer is created
- Customer Favorite Products Created: Triggers when a customer adds a product to favorites
- Customer Favorite Products Updated: Triggers when customer favorite products are updated
- Customer Updated: Triggers when a customer is updated
- Order Created: Triggers when a new order is created
- Order Updated: Triggers when an order is updated
- Product Created: Triggers when a new product is created
- Product Updated: Triggers when a product is updated
- Stock Created: Triggers when new stock is created
- Stock Updated: Triggers when stock is updated

Output

The node outputs JSON data representing the event payload received from IKAS. The structure includes:

  • event: The event type selected in the node properties.
  • timestamp: The ISO timestamp when the event was processed.
  • scope: The scope of the event (from the webhook payload).
  • merchantId: Identifier of the merchant/store related to the event.
  • headers: HTTP headers received with the webhook request.
  • _rawData: The full raw event data object.
  • Additional fields merged from the data property of the event payload if it exists and is an object.

If the incoming webhook payload contains a stringified JSON in its data field, the node attempts to parse it into an object before merging.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the IKAS platform.
  • Uses GraphQL queries and mutations to manage webhooks on the IKAS side.
  • The node requires proper configuration of the webhook URL within n8n to receive events from IKAS.

Troubleshooting

  • Webhook registration failures: If the node cannot create or verify the webhook on IKAS, ensure the API key credential is valid and has sufficient permissions.
  • Event mismatch: If the workflow does not trigger, verify that the event selected in the node matches the x-ikas-event header sent by IKAS. The node ignores events that do not match the configured event.
  • JSON parsing errors: If the webhook payload's data field is a malformed JSON string, the node logs an error but continues processing with the original data.
  • Network issues: Ensure that the webhook URL is publicly accessible by IKAS and that no firewall or proxy blocks incoming requests.

Links and References


This summary is based solely on static analysis of the provided source code and input property definitions.

Discussion