Skip to main content
POST
Criar automação

Permissões

Requer um usuário de serviço com a permissão ManageOrgAutomations no nível da organização.

Identidade de execução

O campo run_as é obrigatório. As automações criadas por usuários de serviço devem usar organization; usuários humanos que fazem chamadas à API e têm a permissão UsePersonalAutomations podem usar creator para executar sessões com as permissões do criador.

Gatilhos e ações

Uma automação é acionada quando qualquer um dos seus triggers corresponde a um evento e, em seguida, executa suas actions (por exemplo, iniciando uma sessão do Devin com um prompt). Use o endpoint de esquemas de eventos para identificar os tipos de eventos de gatilho compatíveis, seus campos e operadores de condição e os verbos de resposta aceitos por cada tipo de evento. As conditions de gatilho usam uma estrutura de dois níveis — {"any": [{"all": [...]}]} — com condições no formato {field, operator, value}; um objeto de condições null corresponde a todos os eventos.

Gatilhos de webhook

Uma automação com um gatilho webhook:incoming (no máximo um) recebe uma URL de entrada e um segredo no momento da criação. O segredo é gerado novamente e retornado quando um gatilho de webhook é readicionado durante uma atualização; ele não pode ser recuperado novamente, portanto, guarde-o ao recebê-lo. Sistemas externos o enviam no cabeçalho X-Webhook-Secret.

Autorizações

Authorization
string
header
obrigatório

Credencial de usuário de serviço (prefixo: cog_)

Parâmetros de caminho

org_id
string
obrigatório

ID da organização (prefixo: org-)

Exemplo:

"org-abc123def456"

Corpo

application/json
actions
(AutomationStartSessionAction · object | AutomationMessageSessionAction · object | AutomationMonitorSessionAction · object)[]
obrigatório

Não vazio. Limites: no máximo um start_session; monitor_session deve ser a única ação.

name
string
obrigatório
Required string length: 1 - 500
run_as
AutomationRunAsOrganization · object
obrigatório

Obrigatório: escolha explicitamente a identidade sob a qual as sessões geradas são executadas (organização ou criador).

triggers
AutomationTriggerRequest · object[]
obrigatório

É acionada quando qualquer acionador corresponde, uma vez por evento. No máximo um acionador webhook:incoming.

concurrency
AutomationConcurrency · object | null
enabled
boolean
padrão:true
limits
AutomationLimits · object | null
metadata
Metadata · object

Rótulos de chave-valor visíveis na organização para organizar e filtrar automações. No máximo 16 pares; chaves com no máximo 32 caracteres; valores com no máximo 128.

notifications
AutomationNotifications · object | null
security_profile
AutomationSecurityProfileSelection · object | null

A associação da automação ao perfil de segurança; se omitida, herda da organização/Enterprise. Requer a permissão de gerenciamento de perfis de segurança.

session_settings
AutomationSessionSettings · object | null

Aplicado às sessões geradas por esta automação.

template_id
string | null

Marcador de procedência exclusivo da criação; resolva IDs por meio do endpoint de templates. Quando definido e tools.mcp_servers é omitido, os required_mcps do template são aplicados.

tools
AutomationTools · object | null

Resposta

Resposta bem-sucedida

actions
(AutomationStartSessionAction · object | AutomationMessageSessionAction · object | AutomationMonitorSessionAction · object)[]
obrigatório
automation_id
string
obrigatório
created_at
integer
obrigatório
created_by
ActorResponse · object
obrigatório

Um principal de usuário ou de usuário de serviço atribuído a uma ação ou recurso.

enabled
boolean
obrigatório
name
string
obrigatório
triggers
AutomationTriggerResponse · object[]
obrigatório
updated_at
integer
obrigatório
concurrency
AutomationConcurrency · object | null
last_edited_by
ActorResponse · object | null

Um principal de usuário ou de usuário de serviço atribuído a uma ação ou recurso.

last_invocation
AutomationLastInvocation · object | null
limits
AutomationLimits · object | null
metadata
Metadata · object
notifications
AutomationNotifications · object | null
run_as
AutomationRunAsOrganization · object

Identidade sob a qual as sessões geradas são executadas. organization: a identidade de automação da organização (o Usuário do sistema no app) — as sessões usam permissões do sistema; portanto, servidores MCP instalados com uma conexão pessoal (com escopo de usuário) não podem ser selecionados, e alterar uma automação para organization os remove da seleção. creator: automação pessoal — é executada com as permissões do próprio criador e fica visível apenas para o criador e administradores da organização; rejeitada para automações criadas por usuário de serviço. Obrigatório na criação; null na atualização redefine para organization.

security_profile
AutomationSecurityProfileResponse · object | null

A associação da automação ao perfil de segurança e os perfis aplicáveis determinados. null quando os perfis de segurança não estão ativados para a organização.

session_settings
AutomationSessionSettings · object | null

Aplicado a todas as sessões geradas por esta automação (incluindo sessões de monitoramento).

template_id
string | null
tools
AutomationTools · object | null