Listar eventos e estado das entregas

GET

/v1/webhook/eventos

curl --request GET \
  --url https://api.cotejar.com.br/v1/webhook/eventos \
  --header 'Authorization: Bearer <token>'

• Produção

Exige webhook:gerenciar. Mais recentes primeiro, até 100 eventos e orçamento de 1 MiB por página. Cursor opaco da mesma empresa. Consulta permitida após suspensão.

Autorizações

• bearerAuth

Parâmetros

Parâmetros de consulta

limite

string

/^(?:[1-9]|[1-9][0-9]|100)$/

cursor

string

>= 1 caractere <= 2048 caracteres

Respostas

200

Response for status 200

Tipo de mídiaapplication/json

object

itens

obrigatório

Array<object>

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

string formato: integer

0

integer

integer

estado

obrigatório

string

Valores permitidos: pendente executando entregue falhou cancelado

tentativas_ciclo

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

tentativas_totais

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

criado_em

obrigatório

string

terminado_em

obrigatório

Qualquer um de:

string

string

null

null

proxima_tentativa_em

obrigatório

Qualquer um de:

string

string

null

null

prazo_em

obrigatório

string

codigo_falha

obrigatório

Qualquer um de:

string

string

null

null

status_http

obrigatório

Qualquer um de:

unknown

Qualquer um de:

string

string formato: integer

0

integer

integer

null

null

proximo_cursor

obrigatório

Qualquer um de:

string

string

null

null

Exemplo

{
  "itens": [
    {
      "tipo": "catalogo.aplicado",
      "destino_versao": 0,
      "estado": "pendente",
      "tentativas_ciclo": 0,
      "tentativas_totais": 0,
      "status_http": 0
    }
  ]
}

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

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

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

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

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

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

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

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

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

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

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

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}