1. Webhooks
  • 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
  • Projetos
    • Entendendo Projetos
    • Criação de Projeto
      POST
  • Medição
    • Entendendo a Medição
    • Criação de Medição
      POST
    • Consulta de Impostos da Empresa
      GET
    • Adição de Retenções Fiscais em uma Medição
      POST
    • Criação de Parcela em Medição
      POST
    • Validação das Parcelas
      POST
    • Validação da Medição
      PATCH
    • Mudança de Status da Medição
      PATCH
  • Contas a Pagar
    • Entendendo o Contas a Pagar
    • Adicinar Comprovante de Pagamento em Parcela
      POST
  • Fluxo Financeiro
    • Entendendo o Fluxo Financeiro
  • Webhooks
    • Entendendo o Payload
    • Eventos
      • Utilizando Webhooks
      • Criação de Medição
      • Atualização de Medição
      • Criação e Atualização de Parcela
      • Criação e Atualização de Fluxo Financeiro
  1. Webhooks

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.
Modificado em 2024-05-07 14:32:57
Página anterior
Entendendo o Fluxo Financeiro
Próxima página
Utilizando Webhooks
Built with