set-accounts-webhook

Configuração de Webhooks para Contas

Este endpoint representa as configurações para o envio de notificações via webhook, permitindo que integradores recebam atualizações sobre o status de contas. Abaixo está a explicação de cada elemento do JSON:

Propriedades

send_failure_notification

Descrição: Define se o sistema deve enviar uma notificação ao email de cadastro do integrador em caso de falha no envio do webhook.

Valores possíveis:

true: Uma notificação será enviada ao email do integrador em caso de erro.

false: Nenhuma notificação será enviada em caso de falha.

accounts

Contém duas propriedades importantes para a configuração de webhooks associados ao status de contas:

hosts

Descrição: Lista de URLs que receberão as notificações via webhook.

Limitação: O número máximo de URLs permitidas é 4.

Exemplo de configuração:

events

Descrição: Lista de status de contas que o integrador deseja acompanhar por meio de notificações.

Valores possíveis: Listados no AccountStatusEnum.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
    "send_failure_notification": false,
    "accounts": {
        "hosts": [
            "http://127.0.0.1/webhook",
            "http://127.0.0.2/webhhok"
        ],
        "events": [
            "validated",
            "processing",
            "rejected",
            "denied",
            "approved",
            "fail",
            "disabled",
            "blocked"
        ]
    }
}

set-accounts-webhook

Configuração de Webhooks para Contas#

Propriedades#

Requisição

Respostas

Configuração de Webhooks para Contas

Propriedades