Introdução#
Quando os dados gerais de uma medição são informados, a medição é criada com o status Rascunho.Após a criação, as próximas informações são enviadas em eventos de atualização da medição.A estrutura do metadata deste evento é padrão e segue a seguinte ordem:Campo | Descrição |
---|
id | Identificador do evento |
companyId | Identificador da empresa criando a medição |
stakeholders | CNPJ de empresas que receberão este evento |
name | Título do evento |
userId | Identificador do usuário criando a medição |
resourceId | Identificador da medição |
dateTime | Horário da criação da medição |
metadata.measurementId | Identificador da medição |
metadata.projectId | Identificador do projeto |
metadata.status | Status da medição |
process | Informação se a medição está completa ou incompleta |
Exemplo de Payload#
{
"id":"3902346d-ef1a-4834-8f8f-66540edf3e43",
"companyId":181,
"stakeholders":["61574522000191"],
"name":"MEASUREMENT_CREATED",
"userId":"206",
"resourceId":"558",
"dateTime":"2024-04-25 14:48:24",
"metadata":{
"measurementId":558,
"projectId":6,
"status":"DRAFT",
"process":"INCOMPLETE"
}
}
O que esperamos como retorno#
Ao retorar o http status da família 200 (sucesso) será considerado pelo time ONE que os dados foram inseridos com sucesso na fatura no seu ERP.Importante frisar que o sucesso deste webhook não se dá pelo recebimento de seus dados, mas sim em sua atualização da informação no sistema ERP.Consideramos que qualquer retorno diferente da família 200 como falha na integração e tentaremos reenviar os dados novamente por mais 5 (cinco) vezes. Persistindo a falha, haverá um reprocessamento durante a noite, notificando a equipe de suporte ONE para solução do problema.Modificado em 2024-05-07 14:33:14