Agendar evento de teste

POST

/v1/webhook/testes

curl --request POST \
  --url https://api.cotejar.com.br/v1/webhook/testes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: pedido-exemplo-00000001' \
  --header 'if-match: example' \
  --data '{}'

• Produção

Exige assinatura ativa, webhook:gerenciar, ETag atual do destino e idempotência. Testes e reenvios compartilham teto de 5 pedidos/minuto por empresa. 202 confirma aceite na fila, não sucesso da conexão.

Autorizações

• bearerAuth

Parâmetros

Parâmetros de cabeçalho

idempotency-key

obrigatório

Gere uma chave por pedido e preserve-a somente nas repetições desse mesmo pedido.

string

>= 16 caracteres <= 128 caracteres /^[A-Za-z0-9._:-]+$/

Exemplo

pedido-exemplo-00000001

if-match

obrigatório

ETag completo da consulta do recurso, incluindo aspas.

string

Corpo da requisição

Tipo de mídiaapplication/json

object

0

Exemplo^gerado

{}

Respostas

202

Response for status 202

Tipo de mídiaapplication/json

object

evento_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_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

Valor permitido: aceito

Exemplo

{
  "destino_versao": 0,
  "estado": "aceito"
}

Cabeçalhos

Location

string

Caminho da consulta do recurso criado ou da operação aceita. Aceite não comprova conclusão.

400

Response for status 400

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"
  }
}

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"
  }
}

408

Response for status 408

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"
  }
}

409

Response for status 409

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"
  }
}

412

Response for status 412

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"
  }
}

413

Response for status 413

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"
  }
}

415

Response for status 415

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"
  }
}

428

Response for status 428

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"
  }
}