Recuperar uma lista paginada de automizações para um projeto com opções de filtragem


Listar todas as Automizações

As automizações no Blue permitem que você crie fluxos de trabalho poderosos que acionam ações com base em eventos específicos. Este endpoint recupera todas as automizações configuradas para o seu projeto, incluindo seus gatilhos, ações e status atual.

Exemplo Básico

query ListAutomations {
  automationList {
    items {
      id
      isActive
      trigger {
        type
        color
      }
      actions {
        type
        color
      }
      createdAt
    }
    pageInfo {
      totalItems
      hasNextPage
    }
  }
}

Exemplo Avançado

query ListAutomationsAdvanced {
  automationList(
    filter: {
      customFieldIds: ["field_123", "field_456"]
    }
    skip: 0
    take: 50
  ) {
    items {
      id
      isActive
      createdAt
      updatedAt
      
      # Trigger details
      trigger {
        id
        type
        color
        metadata {
          ... on AutomationTriggerMetadataTodoOverdue {
            incompleteOnly
          }
        }
        customField {
          id
          name
          type
        }
        customFieldOptions {
          id
          title
          color
        }
        todoList {
          id
          title
        }
        tags {
          id
          title
          color
        }
        assignees {
          id
          name
          email
        }
      }
      
      # Action details
      actions {
        id
        type
        color
        duedIn
        assigneeTriggerer
        
        # Action-specific fields
        customField {
          id
          name
        }
        customFieldOptions {
          id
          title
        }
        todoList {
          id
          title
        }
        tags {
          id
          title
        }
        assignees {
          id
          name
        }
        
        # Email action metadata
        metadata {
          ... on AutomationActionMetadataSendEmail {
            email {
              subject
              to
              from
              content
            }
          }
          ... on AutomationActionMetadataCreateChecklist {
            checklists {
              title
              checklistItems {
                title
                duedIn
              }
            }
          }
        }
      }
      
      # Creator info
      createdBy {
        id
        name
        email
      }
    }
    
    pageInfo {
      totalItems
      totalPages
      hasNextPage
      hasPreviousPage
    }
    
    totalCount
  }
}

Parâmetros de Entrada

AutomationFilterInput

Parâmetro Tipo Necessário Descrição
customFieldIds [String] Não Filtrar automizações relacionadas a campos personalizados específicos

Parâmetros de Paginação

Parâmetro Tipo Necessário Descrição
skip Int Não Número de itens a serem ignorados (padrão: 0)
take Int Não Número de itens a serem retornados (padrão: 20)

Campos de Resposta

AutomationPagination

Campo Tipo Descrição
items [Automation!]! Lista de objetos de automização
pageInfo PageInfo! Informações de paginação
totalCount Int! Número total de automizações

Automation

Campo Tipo Descrição
id ID! Identificador único
trigger AutomationTrigger! O evento que aciona esta automização
actions [AutomationAction!]! Ações realizadas quando acionadas
isActive Boolean! Se a automização está atualmente ativa
createdBy User! Usuário que criou a automização
project Project! Projeto ao qual esta automização pertence
createdAt DateTime! Timestamp de criação
updatedAt DateTime! Timestamp da última atualização

AutomationTrigger

Campo Tipo Descrição
id ID! Identificador único
type AutomationTriggerType! Tipo de evento de gatilho
color String Cor associada (formato hex)
metadata AutomationTriggerMetadata Configuração específica do gatilho
customField CustomField Campo personalizado relacionado (se aplicável)
customFieldOptions [CustomFieldOption!] Opções selecionadas para campos de seleção
todos [CustomFieldReferenceTodo!] Todos referenciados
todoList TodoList Lista de todos relacionada
tags [Tag!] Tags relacionadas
assignees [User!] Atribuídos relacionados

AutomationAction

Campo Tipo Descrição
id ID! Identificador único
type AutomationActionType! Tipo de ação a ser realizada
color String Cor associada (formato hex)
duedIn Int Dias a adicionar para ações de data de vencimento
assigneeTriggerer String Identificador especial do atribuído
metadata AutomationActionMetadata Configuração específica da ação
customField CustomField Campo personalizado alvo
customFieldOptions [CustomFieldOption!] Opções para campos de seleção
todoList TodoList Lista de todos alvo
tags [Tag!] Tags a adicionar/remover
assignees [User!] Atribuídos a adicionar/remover
httpOption AutomationActionHttpOption Configuração da requisição HTTP

Tipos de Gatilho

Tipo Descrição
TODO_CREATED Quando um novo registro é criado
TODO_LIST_CHANGED Quando um registro se move entre listas
TODO_MARKED_AS_COMPLETE Quando um registro é concluído
TODO_MARKED_AS_INCOMPLETE Quando um registro é desfeito
ASSIGNEE_ADDED Quando um atribuído é adicionado
ASSIGNEE_REMOVED Quando um atribuído é removido
DUE_DATE_CHANGED Quando a data de vencimento é modificada
DUE_DATE_REMOVED Quando a data de vencimento é limpa
DUE_DATE_EXPIRED Quando a data de vencimento passa
TAG_ADDED Quando uma tag é adicionada
TAG_REMOVED Quando uma tag é removida
CHECKLIST_ITEM_MARKED_AS_DONE Quando um item da lista de verificação é concluído
CHECKLIST_ITEM_MARKED_AS_UNDONE Quando um item da lista de verificação é desfeito
TODO_COPIED_OR_MOVED_FROM_OTHER_PROJECT Quando o registro é importado
CUSTOM_FIELD_ADDED Quando o valor do campo personalizado é definido
CUSTOM_FIELD_REMOVED Quando o valor do campo personalizado é limpo
CUSTOM_FIELD_BUTTON_CLICKED Quando o campo de botão é clicado
COLOR_ADDED Quando a cor é aplicada
COLOR_REMOVED Quando a cor é removida

Tipos de Ação

Tipo Descrição
CHANGE_TODO_LIST Mover registro para lista diferente
MARK_AS_COMPLETE Completar o registro
MARK_AS_INCOMPLETE Desfazer a conclusão do registro
ADD_ASSIGNEE Adicionar atribuído(s)
REMOVE_ASSIGNEE Remover atribuído(s)
ADD_ASSIGNEE_TRIGGERER Adicionar usuário que acionou a automização
CHANGE_DUE_DATE Definir ou atualizar a data de vencimento
REMOVE_DUE_DATE Limpar a data de vencimento
ADD_TAG Aplicar tag(s)
REMOVE_TAG Remover tag(s)
ADD_COLOR Aplicar cor
REMOVE_COLOR Remover cor
ADD_CUSTOM_FIELD Definir valor do campo personalizado
REMOVE_CUSTOM_FIELD Limpar valor do campo personalizado
CREATE_CHECKLIST Criar nova lista de verificação
MARK_CHECKLIST_ITEM_AS_DONE Completar itens da lista de verificação
MARK_CHECKLIST_ITEM_AS_UNDONE Desfazer itens da lista de verificação
COPY_TODO Duplicar o registro
SEND_EMAIL Enviar notificação por e-mail
GENERATE_PDF Gerar documento PDF
MAKE_HTTP_REQUEST Chamar API externa

Permissões Necessárias

Listar automizações requer autenticação e acesso ao projeto:

Função Pode Listar Automizações
OWNER ✅ Sim
ADMIN ✅ Sim
MEMBER ✅ Sim
CLIENT ✅ Sim

Todos os usuários autenticados com acesso ao projeto podem visualizar automizações.

Respostas de Erro

Autenticação Necessária

{
  "errors": [{
    "message": "You must be logged in",
    "extensions": {
      "code": "UNAUTHENTICATED"
    }
  }]
}

Projeto Não Encontrado

{
  "errors": [{
    "message": "Project not found",
    "extensions": {
      "code": "PROJECT_NOT_FOUND"
    }
  }]
}

Notas Importantes

  • Ordenação: As automizações são sempre retornadas do mais novo para o mais antigo (por data de criação)
  • Escopo do Projeto: As automizações são limitadas ao contexto do projeto atual
  • Status Ativo: Verifique isActive para determinar se uma automização está atualmente em execução
  • Metadados: Alguns gatilhos e ações têm metadados adicionais para configuração
  • Desempenho: Use paginação para projetos com muitas automizações
  • Filtragem: Atualmente, suporta apenas filtragem por IDs de campos personalizados

Assistente de IA

As respostas são geradas usando IA e podem conter erros.

Como posso ajudá-lo?

Pergunte-me qualquer coisa sobre o Blue ou esta documentação.

Digite para enviar • Shift+Enter para nova linha • ⌘I para abrir