Automation Actions

Before You Begin

🔗 Use the GraphQL Playground to execute the queries in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
Repo ID: Identify the repo to retrieve the automation actions from, due to the possibility of some action to be disabled. If omitted, the query will return all automation actions, but some might be disabled.

Step 1: Find Your Repo ID

1. Via Pipefy UI

Open the pipe in your browser.
The URL will include the Repo ID: https://app.pipefy.com/pipes/9876543210.
Repo ID = 9876543210 (the number after /pipes/).

2. Via GraphQL Query

Refer to our Get resource IDs page for alternative methods.

Step 2: Query Automation Actions

Use the automationActions query to retrieve available automation actions. Below are some examples:

{
  automationActions {
    id
    enabled
    disabledReason
    eventsBlacklist
    acceptedParameters
    initiallyHidden
    icon
    triggerEvents
  }
}

With repo

{
  automationActions(repoId: "1234") {
    id
    enabled
    disabledReason
    eventsBlacklist
    acceptedParameters
    initiallyHidden
    icon
    triggerEvents
  }
}

Key Fields Explained:

id: Automation action unique identifier.
enabled: Indicates if the action is enabled (true) or disabled (false).
disabledReason: If disabled, returns an identifier of the reason.
eventsBlacklist: A list of events that cannot trigger the action.
acceptedParameters: A list of parameters accepted by the action.
initiallyHidden: Indicates if the action should be initially hidden when creating a new automation, and be displayed only after selecting the event.
icon: The icon name to be displayed with the action name.
triggerEvents: A list of events that can relate to the action in a way that could generate an infinite loop of automations.

Step 3: Execute and Interpret the Response

After running the query, you'll receive a structured JSON response. Here’s an example:

{
  "data": {
    "automationActions": [
      {
        "id": "generate_with_ai",
        "enabled": true,
        "disabledReason": null,
        "eventsBlacklist": ["scheduler"],
        "acceptedParameters": ["ai_params"],
        "initiallyHidden": null,
        "icon": "i-ai-automation",
        "triggerEvents": ["field_updated"]
      },
      {
        "id": "send_a_task",
        "enabled": true,
        "disabledReason": null,
        "eventsBlacklist": ["scheduler", "sla_based", "card_left_phase", "manually_triggered"],
        "acceptedParameters": ["task_params"],
        "initiallyHidden": null,
        "icon": "i-form",
        "triggerEvents": []
      },
      {
        "id": "move_single_card",
        "enabled": true,
        "disabledReason": null,
        "eventsBlacklist": ["scheduler", "manually_triggered"],
        "acceptedParameters": ["to_phase_id"],
        "initiallyHidden": null,
        "icon": "i-move-in",
        "triggerEvents": ["card_moved", "all_children_in_phase"]
      },
      {
        "id": "create_card",
        "enabled": true,
        "disabledReason": null,
        "eventsBlacklist": ["scheduler", "manually_triggered"],
        "acceptedParameters": ["fields_map_order"],
        "initiallyHidden": null,
        "icon": "i-card",
        "triggerEvents": ["card_created", "field_updated", "sla_based"]
      }
    ]
  }
}

This query provides a quick and effective way to retrieve a list of available automation actions.