Configurar ou rotacionar webhook

PUT

/v1/webhook

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

• Produção

Exige webhook:gerenciar e assinatura ativa. Corpo até 4 KiB. Crie com If-None-Match: *; altere com If-Match. Cada alteração gera novo segredo e invalida entregas da versão anterior. ETag identifica a configuração consultável. Repetição devolve o recibo original e não reativa destino revogado.

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

ETag completo da configuração atual; obrigatório para alterar ou reativar.

string

if-none-match

Use * somente para criar. Não combine com If-Match.

string

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

url

obrigatório

HTTPS público na porta 443, sem credenciais ou fragmento.

string

<= 2048 caracteres

Exemplo^gerado

{
  "url": "example"
}

Respostas

200

Response for status 200

Tipo de mídiaapplication/json

object

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}$/

versao

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

estado

obrigatório

string

Valor permitido: ativo

url

obrigatório

string

segredo

obrigatório

Guarde com segurança; exibido nesta operação e em sua repetição idempotente.

string

Exemplo

{
  "id": "0198d000-0000-7000-8000-000000000001",
  "versao": 0,
  "estado": "ativo"
}

Cabeçalhos

ETag

string

Versão opaca do recurso, incluindo aspas. Preserve o valor completo ao enviar If-Match.

Location

string

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

201

Response for status 201

Tipo de mídiaapplication/json

object

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}$/

versao

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

estado

obrigatório

string

Valor permitido: ativo

url

obrigatório

string

segredo

obrigatório

Guarde com segurança; exibido nesta operação e em sua repetição idempotente.

string

Exemplo

{
  "id": "0198d000-0000-7000-8000-000000000001",
  "versao": 0,
  "estado": "ativo"
}

Cabeçalhos

ETag

string

Versão opaca do recurso, incluindo aspas. Preserve o valor completo ao enviar If-Match.

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