create

Quando usar

Criar configuração de webhook para um tipo (account ou transaction)

Se já existir configuração ativa para o tipo, usar update

Regras de validação

type: obrigatório, account|transaction

hosts: obrigatório, array com no mínimo 1 item

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

events: opcional, array

events.*: quando enviado, obrigatório e válido para o type

Resposta `200`

{
  "data": {
    "type": "account",
    "hosts": ["https://meu-sistema.com/webhooks/accounts"],
    "events": ["approved", "validated"],
    "is_active": true
  }
}

Erros comuns

422 tipo/evento/URL inválido

400 quando já existe webhook ativo para o tipo

Catálogo de eventos válidos

`account`

register

validating

validated

processing

rejected

denied

approved

fail

disabled

blocked

transactions_limit_update

`transaction`

ACCOUNT_CREATION

DEPOSIT_BOLETO

DEPOSIT_DIRECT_DEBIT

DEPOSIT_INSTANT_PAYMENT

INTERNAL_PAYMENT

INSTANT_PAYMENT_ALIAS

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

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

{
    "type": "transaction",
    "hosts": ["https://meu-sistema.com/webhooks/baas"],
    "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"
    ]
}

Quando usar#

Regras de validação#

Resposta 200#

Erros comuns#

Catálogo de eventos válidos#

account#

transaction#