Especificação de Eventos
Referência canônica para as oito categorias de eventos integradas — propósito, campos comuns e restrições de ordenação.
Esta página é a referência canônica para a modelagem de eventos no nível macro/base.
Categorias lógicas de eventos integradas
| Tipo | Propósito |
|---|---|
ACTOR | Concede ou atualiza papéis/permissões de participantes na linha do tempo do documento. |
CLOSE | Encerra o documento para atualizações futuras (exceto fluxos de relação específicos). |
CANCEL | Cancela o documento e bloqueia ações futuras. |
RELATED | Cria vínculos de relação entre documentos. |
UPDATE | Atualiza campos selecionados relacionados à visibilidade do documento. |
SPLIT | Cria um novo documento com parte do valor existente. |
OUTPUT | Cria um documento downstream a partir do contexto atual. |
CUSTOM | Nomes de eventos específicos da metodologia/aplicação. |
Para padrões de implementação usando categorias de eventos específicas, consulte:
ACTOR: Guia de PermissõesCANCEL/CLOSE: Guia de Tratamento de ErrosRELATED/SPLIT/OUTPUT: Submetendo um MassIDUPDATE: Guia de Privacidade e MascaramentoCUSTOM: Definidos por metodologia — consulte os guias de integração por metodologia para os eventos e regras de validação específicos.
Campos comuns de eventos
A maioria dos payloads de eventos compartilha estes campos principais:
nameexternalCreatedAtisPublicmetadata- um entre
participantouparticipantId(obrigatório) - um entre
addressouaddressId(obrigatório) attachments(opcional)deduplicationId(opcional)
Para integrações orientadas por metodologia, eventos ACTOR devem incluir um label que identifica o papel do participante. Cada guia de integração por metodologia define os labels permitidos e a ordem obrigatória. Não utilize campos de papel descontinuados como actor-type.
Eventos CUSTOM
Eventos CUSTOM aceitam qualquer name — Integradores podem definir e enviar quaisquer eventos operacionais adequados ao seu fluxo de trabalho. A plataforma não restringe nomes de eventos CUSTOM no nível da API.
Metodologias definem seus próprios vocabulários de eventos CUSTOM esperados e os validam por meio de regras de aplicação. Consulte o guia de integração por metodologia relevante para os eventos específicos e regras de validação aplicáveis.
Restrições de ordenação e propagação
- Os timestamps dos eventos devem permanecer cronologicamente consistentes.
- O comportamento de propagação é restrito e deve ser explicitamente validado em testes de integração.
- Utilize padrões de retentativas determinísticos para evitar entradas duplicadas na linha do tempo.
Referência de endpoint: API de Eventos.