Trigger Nodes - Membrane Docs

Trigger nodes are special nodes that start flow execution. Every flow must have at least one trigger. A flow can have multiple triggers if you want to reuse the same integration logic in different scenarios.

API Trigger

Type: api-trigger The API Trigger allows you to launch a Flow Instance with optional input using your application’s API or SDK.

trigger:
  type: api-trigger
  name: Manual Sync Trigger
  config:
    inputSchema:
      type: object
      properties:
        recordId:
          type: string
        syncAll:
          type: boolean

Configuration options:

inputSchema – Optional schema that will be validated when the flow is triggered

Output: The output contains the input provided when triggering the flow:

{
  recordId: '12345',
  syncAll: false
}

Schedule Trigger

Type: schedule-trigger The Schedule Trigger runs a flow at regular intervals as long as the Flow Instance is enabled.

trigger:
  type: schedule-trigger
  name: Hourly Sync
  config:
    intervalMinutes: 60

Configuration options:

intervalMinutes – How often the flow should run (5 = every 5 minutes, 60 = hourly, 1440 = daily)

Output: The output contains timing information:

{
  triggeredAt: '2024-01-15T10:30:00Z'
}

Internal Event Trigger

Type: app-event-trigger The Internal Event Trigger runs a flow when a specific event occurs in your application. Before using this trigger, you need to create an Internal Event.

trigger:
  type: app-event-trigger
  name: Order Created Event
  config:
    appEventKey: order-created
    filter:
      $eval:
        $var: $.payload.amount
      $gt: 1000

Configuration options:

appEventKey – Key of the internal event to listen to
filter – Optional filter to conditionally trigger the flow based on event data

Output: The output contains the event payload:

{
  payload: {
    orderId: '12345',
    amount: 1500,
    customer: 'customer-id'
  }
}

​API Trigger

​Schedule Trigger

​Internal Event Trigger

API Trigger

Schedule Trigger

Internal Event Trigger