Pular para o conteúdo
CotejarCotejarCotejar para desenvolvedores

Consultar evento e situação da entrega

GET
/v1/webhook/eventos/{id}
curl --request GET \
  --url https://api.cotejar.com.br/v1/webhook/eventos/0198d000-0000-7000-8000-000000000001 \
  --header 'Authorization: Bearer <token>'

Inclui o envelope original assinado e metadados sanitizados. Não retorna segredo nem resposta do receptor.

Autorizações

Seção intitulada “Autorizações”

Parâmetros

Seção intitulada “Parâmetros”

Parâmetros de caminho

Seção intitulada “Parâmetros de caminho”
id
obrigatório

Exemplo sintético; substitua pelo UUID obtido na consulta do seu recurso.

string
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/
Exemplo
0198d000-0000-7000-8000-000000000001

Respostas

Seção intitulada “Respostas”

200

Seção intitulada “200”

Response for status 200

Tipo de mídiaapplication/json
object
id
obrigatório
string
/^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/
tipo
obrigatório
string
Valores permitidos: catalogo.aplicado catalogo.revisao_necessaria analise.concluida analise.falhou divergencias.alteradas vigilancia.degradada vigilancia.restabelecida webhook.teste
ocorrido_em
obrigatório
string
destino_id
obrigatório
string
/^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/
destino_versao
obrigatório
Qualquer um de:
string formato: integer
0
estado
obrigatório
string
Valores permitidos: pendente executando entregue falhou cancelado
tentativas_ciclo
obrigatório
Qualquer um de:
string formato: integer
0
tentativas_totais
obrigatório
Qualquer um de:
string formato: integer
0
criado_em
obrigatório
string
terminado_em
obrigatório
Qualquer um de:
string
proxima_tentativa_em
obrigatório
Qualquer um de:
string
prazo_em
obrigatório
string
codigo_falha
obrigatório
Qualquer um de:
string
status_http
obrigatório
Qualquer um de:
Qualquer um de:
string formato: integer
0
evento
obrigatório
object
id
obrigatório
string
/^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/
versao
obrigatório
number
Valor permitido: 1
empresa
obrigatório
string
/^[0-9]{8}$/
ocorridoEm
obrigatório
string
dados
obrigatório
Qualquer um de:
object
tipo
obrigatório
string
Valor permitido: catalogo.aplicado
catalogoId
obrigatório
string
/^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/
versao
obrigatório
Qualquer um de:
string formato: integer
0
Exemplo
{
  "tipo": "catalogo.aplicado",
  "destino_versao": 0,
  "estado": "pendente",
  "tentativas_ciclo": 0,
  "tentativas_totais": 0,
  "status_http": 0,
  "evento": {
    "versao": 1,
    "dados": {
      "tipo": "catalogo.aplicado",
      "versao": 0
    }
  }
}

401

Seção intitulada “401”

Response for status 401

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

403

Seção intitulada “403”

Response for status 403

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

404

Seção intitulada “404”

Response for status 404

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

422

Seção intitulada “422”

Response for status 422

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

429

Seção intitulada “429”

Response for status 429

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

503

Seção intitulada “503”

Response for status 503

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}