1. Eventos
  • Introdução
    • Integração ONE
    • Visão Geral da API Rest
    • Ciclo de Vida da API
  • Ambiente
    • Ambiente
  • Autenticação
    • Gerando Chaves de Acesso
    • Autenticando-se
    • Token de Acesso
      POST
  • Pré-Autorização
    • Entendendo a Pré-Autorização
    • Criar uma Pré-Autorização
      POST
    • Cancelar uma Pré-Autorização
      PATCH
  • Webhooks
    • Utilizando Webhooks
    • Eventos
      • Entendendo o Payload
      • Atualização de Pré-Autorização
      • Atualização de Prospecção de Antecipação
      • Atualização de Antecipação
      • Troca de Boletos
  1. Eventos

Entendendo o Payload

Cabeçalho do Evento#

Os eventos possuem informações sobre sua criação e seu conteúdo que são disponibilizados no cabeçalho para uma eventual auditoria ou consulta.
A estrutura do cabeçalho é padrão e segue a seguinte ordem:
CampoDescrição
idIdentificador único do evento
companyIdIdentificador da empresa que originou o evento
nameNome do evento
userIdIdentificador do usuário que originou o evento
resourceIdIdentificador do recurso alterado (Ex: usuário, antecipação)
dateTimeData e hora da ocorrência do evento

Corpo do Evento#

As informações contidas no campo "metadata" referem-se ao evento em si. Seja a inclusão de um arquivo, a identificação de uma persona ou quaisquer informações relevantes para este evento.
Cada tipo evento possui uma estrutura de "metadata" própria de acordo com a necessidade de envio de informações. Consulte os eventos nos próximos tópicos para entender sua função e verificar os campos retornados.
Modified at 2023-04-13 13:16:12
Previous
Utilizando Webhooks
Next
Atualização de Pré-Autorização
Built with