SopagueDocs
v3

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=="
}
Exemplo de resposta
{
  "message": "Autenticação de webhook cadastrada com sucesso"
}

Dicionário de dados - Retorno

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