Cadastrar Autenticação de Webhook

POST/v1/security/webhook-auth

Cadastra uma autenticação "Basic" que será incluída automaticamente no header das requisições de webhook.

Requisição

{
  "basic": "Basic <Base64>"
}

Dicionário de dados - Parâmetros

Regras de validação

O campo basic é obrigatório
Deve iniciar com "Basic "
O conteúdo após "Basic " deve ser um Base64 válido
É permitido apenas um cadastro ativo por cliente

Exemplo de requisição

{
  "basic": "Basic dXNlcjpwYXNzd29yZA=="
}

Retorno (201)

Exemplo de resposta

{
  "message": "Autenticação de webhook cadastrada com sucesso"
}

Dicionário de dados

Guarde as credenciais com segurança. Elas serão usadas para validar a autenticidade das requisições de webhook recebidas pelo seu sistema.

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Exemplo documentado

[
  {
    "tag": "basic",
    "description": "Campo basic é obrigatório"
  }
]

Observado em homologação

Requisição com corpo JSON vazio ou identificador sintético. O retorno abaixo mostra a validação realizada em homologação.

[
  {
    "tag": "Basic",
    "description": "Basic é obrigatório."
  }
]

Campos da resposta de erro

A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.