API Reference
Support from Community ↗︎

Automation Events

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

  1. Authentication: Use a Service Account token (Personal Access Tokens are deprecated).

Step 1: Query Automation Events

Using automationEvents query

Use the automationEvents query to retrieve available automation events. Below is an example:

{
  automationEvents {
    id
    actionsBlacklist
    acceptedParameters
    icon
  }
}

Key Fields Explained:

  • id: Automation event unique identifier.
  • actionsBlacklist: A list of actions that cannot be triggered by the event.
  • acceptedParameters: A list of parameters accepted by the event.
  • icon: The icon name to be displayed with the action name.

Using automationEventsByPhase query

Use the automationEventsByPhase query to retrieve available automation events, that can be configured directly in a phase. This query returns a different blocklist than the automationEvents query. Below is an example:

{
  automationEventsByPhase {
    id
    blocklistByPhase
    icon
  }
}

Key Fields Explained:

  • id: Automation event unique identifier.
  • blocklistByPhase: A list of actions that cannot be triggered by the event.
  • icon: The icon name to be displayed with the action name.

Step 2: Execute and Interpret the Response

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

{
  "data": {
    "automationEvents": [
      {
        "id": "card_moved",
        "actionsBlacklist": ["move_multiple_cards", "schedule_create_card"],
        "acceptedParameters": ["to_phase_id"],
        "icon": "i-move-in"
      },
      {
        "id": "field_updated",
        "actionsBlacklist": ["move_multiple_cards", "schedule_create_card"],
        "acceptedParameters": ["trigger_field_ids"],
        "icon": "i-refresh"
      },
      {
        "id": "card_created",
        "actionsBlacklist": ["move_multiple_cards", "schedule_create_card"],
        "acceptedParameters": [],
        "icon": "i-card"
      }
    ]
  }
}

{
  "data": {
    "automationEventsByPhase": [
      {
        "id": "card_moved",
        "blocklistByPhase": ["move_multiple_cards", "schedule_create_card"],
        "icon": "i-move-in"
      },
      {
        "id": "field_updated",
        "blocklistByPhase": [
          "create_card",
          "create_connected_card",
          "update_card_field",
          "send_email_template",
          "distribute_assignments",
          "send_http_request",
          "run_a_formula",
          "generate_with_ai",
          "apply_sla_rules",
          "move_multiple_cards",
          "schedule_create_card"
        ],
        "icon": "i-refresh"
      },
      {
        "id": "card_created",
        "blocklistByPhase": [
          "create_card",
          "create_connected_card",
          "update_card_field",
          "send_email_template",
          "distribute_assignments",
          "send_http_request",
          "run_a_formula",
          "generate_with_ai",
          "apply_sla_rules",
          "move_multiple_cards",
          "schedule_create_card"
        ],
        "icon": "i-card"
      }
    ]
  }
}

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