Cadastrar/Alterar Webhook

Cadastra um novo webhook para recebimento de mensagens de um determinado tipo. Caso já exista uma configuração anterior, os dados serão sobrescritos.

Request

A chamada deverá ser feita utilizando o método POST.

URL

{BaseUrl}/api/v1/webhooks

HTTP Headers - Exemplo:

Authorization: Basic {base64(client_id:client_secret)}
Content-Type: application/json

HTTP Request Body

{
    "url": "https://test2.com",
    "type": "pix_in",
    "authorization": "authorization_value"
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
url (Obrigatório)	Endereço destino da mensagem do webhook	STRING limite de 255 caracteres iniciando com https://
type (Opcional)	Tipo de transação que será enviada	STRING pix_in - para transações de pix-in(collection), pix_out - para transações de pix-out(transfer)
authorization (Opcional)	Header Authorization enviado nas notificações	STRING limite de 100 caracteres

aviso

Caso o parâmetro opcional type não seja informado, será registrado o mesmo webhook para os dois tipos de operação: pix_in e pix_out.

informação

Em uma atualização, o campo authorization só é alterado quando enviado na requisição — se omitido, o valor anterior é mantido. Não é possível removê-lo, apenas substituí-lo.

Exemplo cURL – bash:

curl -X POST https://api.moneyguard.com.br/api/v1/webhooks \
    -H "Authorization: Bearer seu_access_token" \
  -H "Content-Type: application/json" \
  -H "User-Agent: seu_user_agent" \
  -d '{
    "url": "https://seu-sistema.com/webhooks/moneyguard",
    "type": "pix_in",
    "authorization": "Bearer seu_token_secreto"
}'

Response

Em caso de sucesso — tanto no cadastro de uma nova configuração quanto na atualização de uma existente — será retornada uma mensagem HTTP 200 informando o êxito da operação.

HTTP 200 Response Body - Exemplo

{
    "message": "Webhook configuration successfully registered"
}

Error

HTTP 400 Response Body - URL inválida

{
    "error": "Error registering webhook. Url must start with: https://"
}