update

Path param

type: obrigatório, account|transaction

Body (JSON)

{
  "hosts": ["https://meu-sistema.com/webhooks/novo-endpoint"],
  "events": ["ACCOUNT_CREATION"]
}

Regras de validação

hosts: obrigatório, array (pode ser vazio)

hosts.*: obrigatório, URL válida, máx. 2048

events: obrigatório, array (pode ser vazio)

events.*: obrigatório, evento válido para o type da rota

Regra funcional importante

Atualização é por substituição completa de hosts e events

Resposta `200`

{
  "data": {
    "type": "transaction",
    "hosts": ["https://meu-sistema.com/webhooks/novo-endpoint"],
    "events": ["ACCOUNT_CREATION"],
    "is_active": true
  }
}

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
  "hosts": [ // obrigatório | array (pode vir vazio) | substitui integralmente webhook.<type>.hosts
    "https://webhook.exemplo.com/novo-endpoint"
  ],
  "events": [ // obrigatório | array (pode vir vazio) | substitui integralmente webhook.<type>.events
    "ACCOUNT_CREATION", // obrigatório quando item existir | deve ser evento válido para o type da URL
    "DEPOSIT_BOLETO",
    "DEPOSIT_DIRECT_DEBIT",
    "DEPOSIT_INSTANT_PAYMENT",
    "INSTANT_PAYMENT_ALIAS",
    "INTERNAL_PAYMENT",
    "INTERNAL_PAYMENT_UNLOCK",
    "MED",
    "PAYMENT_BOLETO",
    "PAYMENT_BOLETO_COBRANCA",
    "PAYMENT_DIRECT_DEBIT",
    "PAYMENT_INSTANT_PAYMENT",
    "WITHDRAW_BANK_TRANSFER",
    "WITHDRAW_BOLETO",
    "WITHDRAW_INSTANT_PAYMENT",
    "WITHDRAW_INSTANT_PAYMENT_RETURN",
    "WITHDRAW_UTILITIES"
  ]
}

Path param#

Body (JSON)#

Regras de validação#

Regra funcional importante#