> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devin.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Obter esquemas de eventos de automação
> Retorna todos os esquemas de eventos de acionamento compatíveis, organizados por origem e, em seguida, por nome do evento.
Cada esquema descreve os campos da carga útil do evento, os operadores compatíveis com suas
condições e os verbos `replies` válidos, para que os chamadores possam
criar `triggers` válidos para os endpoints de criação e atualização.
## Permissões
É necessário um usuário de serviço com a permissão `ViewOrgAutomations` no nível da organização.
## Uso
Chame este endpoint antes de criar automações: ele retorna todos os tipos de evento de acionamento compatíveis (agrupados por origem e, em seguida, por nome do evento), com seus campos de payload, os operadores compatíveis com suas condições e os verbos `replies` válidos, para que você possa criar `triggers` válidos para os endpoints de criação e atualização. As origens que não estão ativadas para a organização são omitidas.
## OpenAPI
````yaml pt-BR/v3-openapi.yaml GET /v3/organizations/{org_id}/automations/schemas
openapi: 3.1.0
info:
description: API Devin v3 com autenticação de usuário de serviço e RBAC
title: Devin API v3
version: 3.0.0
servers: []
security:
- bearerAuth: []
paths:
/v3/organizations/{org_id}/automations/schemas:
get:
tags:
- automations
summary: Obter esquemas de eventos de automação
description: >-
Retorna todos os esquemas de eventos de acionamento compatíveis,
organizados por origem e, em seguida, por nome do evento.
Cada esquema descreve os campos da carga útil do evento, os operadores
compatíveis com suas
condições e os verbos `replies` válidos, para que os chamadores possam
criar `triggers` válidos para os endpoints de criação e atualização.
operationId: >-
handle_get_automation_schemas_v3_organizations__org_id__automations_schemas_get
parameters:
- description: 'ID da organização (prefixo: org-)'
in: path
name: org_id
required: true
schema:
example: org-abc123def456
title: Org Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationSchemasResponse'
description: Resposta bem-sucedida
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Não autorizado
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Proibido
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Não encontrado
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Conflito
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Conteúdo não processável
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Excesso de requisições
components:
schemas:
AutomationSchemasResponse:
additionalProperties: false
properties:
sources:
additionalProperties:
additionalProperties:
$ref: '#/components/schemas/AutomationEventSchemaResponse'
type: object
description: Fonte do evento → nome do evento → esquema.
title: Sources
type: object
update_semantics:
description: >-
Semântica de PATCH ativa para esta organização: 'replace_groups' (um
grupo de configuração presente na requisição substitui integralmente
o grupo armazenado) ou 'merge_patch' (RFC 7396 para objetos: membros
omitidos de um grupo presente mantêm seus valores armazenados;
valores nulos explícitos os removem; a lista ainda é substituída
integralmente — para excluir, reenvie a lista sem o elemento —, mas
cada elemento enviado é mesclado ao elemento armazenado do mesmo
tipo quando esse tipo aparece exatamente uma vez em ambos os lados;
tipos repetidos devem ser informados integralmente). Enumeração
aberta — os clientes devem aceitar novos valores.
title: Update Semantics
type: string
required:
- update_semantics
- sources
title: AutomationSchemasResponse
type: object
ProblemDetail:
description: >-
Corpo de erro RFC 9457 application/problem+json da API v3.
detail é mantido do corpo legado {"detail": ...} por
retrocompatibilidade; os
outros membros são aditivos. errors contém falhas de validação em nível
de campo
(apenas 422).
properties:
detail:
anyOf:
- type: string
- type: 'null'
description: Uma explicação legível por humanos específica para esta ocorrência.
title: Detail
errors:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
description: Erros de validação no nível do campo (apenas respostas 422).
title: Errors
instance:
anyOf:
- type: string
- type: 'null'
description: >-
Uma referência de URI (o caminho da requisição) para esta
ocorrência.
title: Instance
status:
description: O código de status HTTP.
title: Status
type: integer
title:
description: Um breve resumo do tipo de problema, legível para humanos.
title: Title
type: string
type:
default: about:blank
description: Uma referência de URI que identifica o tipo de problema.
title: Type
type: string
required:
- title
- status
title: ProblemDetail
type: object
AutomationEventSchemaResponse:
additionalProperties: false
properties:
category:
title: Category
type: string
event_type:
title: Event Type
type: string
fields:
additionalProperties:
$ref: '#/components/schemas/AutomationSchemaFieldDef'
description: >-
Caminho do campo de condição → definição do campo (tipo, rótulo,
obrigatório, opções, ...).
title: Fields
type: object
name:
title: Name
type: string
supported_replies:
description: Valores válidos de replies[].type para este tipo de evento.
items:
type: string
title: Supported Replies
type: array
required:
- event_type
- name
- category
- supported_replies
- fields
title: AutomationEventSchemaResponse
type: object
AutomationSchemaFieldDef:
additionalProperties: false
description: |-
Visão simplificada da definição de um campo de condição.
Atributos específicos do tipo (``options``, ``min``/``max``/``unit``,
``granularity``, ``placeholder``) são preenchidos apenas para o
``type`` relevante.
properties:
description:
anyOf:
- type: string
- type: 'null'
title: Description
fixed:
default: false
title: Fixed
type: boolean
granularity:
anyOf:
- enum:
- date
- datetime
type: string
- type: 'null'
title: Granularity
label:
title: Label
type: string
max:
anyOf:
- type: number
- type: 'null'
title: Max
min:
anyOf:
- type: number
- type: 'null'
title: Min
multiple:
anyOf:
- type: boolean
- type: 'null'
title: Multiple
options:
anyOf:
- items:
$ref: '#/components/schemas/AutomationSchemaSelectOption'
type: array
- type: 'null'
title: Options
placeholder:
anyOf:
- type: string
- type: 'null'
title: Placeholder
required:
default: false
title: Required
type: boolean
type:
enum:
- string
- number
- boolean
- date
- select
- rrule
- slack_channel
- linear_team
- incident_io_team
- incident_io_severity
- incident_io_status
- incident_io_incident_type
- github_repo
- gitlab_repo
- linear_label
- linear_state
- linear_assignee
- linear_project
- jira_project
- jira_label
- jira_status
- jira_assignee
- jira_epic
- slack_user
- slack_reaction
- pylon_tag
- pylon_status
- file_paths
title: Type
type: string
unit:
anyOf:
- type: string
- type: 'null'
title: Unit
required:
- type
- label
title: AutomationSchemaFieldDef
type: object
AutomationSchemaSelectOption:
additionalProperties: false
properties:
label:
title: Label
type: string
value:
title: Value
type: string
required:
- value
- label
title: AutomationSchemaSelectOption
type: object
securitySchemes:
bearerAuth:
description: 'Credencial de usuário de serviço (prefixo: cog_)'
scheme: bearer
type: http
````