Editar Webhooks

PUT /webhooks

Para utilizar esse método, o access_token deve conter o scope webhooks.write

Método utilizado para alterar a URL e ativar/desativar eventos de webhook

Dados da requisição

Você pode alterar todos os dados abaixo do registro ou apenas o campo que desejar.
Apenas os campos enviados serão validados.

Nome

Tipo

Obrigatório

Explicação

url

string 255 caracteres

Não

URL do Webhook.

events

array de string

Não

Array de eventos a serem ativados. Separe cada um com vírgula.
Para desativar, não informe nenhum.

Valor	Explicação
transaction.updateStatus	Será enviado quando uma transação tiver seu status de pagamento alterado. Vai conter todos os dados da entidade Transaction.
subscription.addTransaction	Será enviado quando uma transação for adicionada em uma assinatura. Vai conter todos os dados da entidade Transaction.
company.cashOut	Será enviado quando um pagamento Pix ou um Saque/Transferência for realizado no sistema.
company.verifyDocuments	Informações de atualização do status de aprovação de conta
chargeback.update	Será enviado quando uma abertura de disputa for criada no sistema. Vai conter todos os dados da entidade Chargeback, além de conter alguns dados da entidade Transaction e PaymentBill.
company.internalTransfer	Será enviado quando uma transferência interna for realizada. Vai conter todos os dados da entidade Transaction.

URL da Requisição

https://api.sandbox.cel.cash/v2/webhooks

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "confirmHash": "4d433fe7ca2c8722edca34c1c49d6a91",
    "events": [
        "transaction.updateStatus"
    ]
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

confirmHash

string 255 caracteres

Hash de confirmação de segurança do webhook.

events

array de string

Array de eventos que foram ativados.

Valor

Explicação

transaction.updateStatus

Será enviado quando uma transação tiver seu status de pagamento alterado. Vai conter todos os dados da entidade Transaction.

subscription.addTransaction

Será enviado quando uma transação for adicionada em uma assinatura. Vai conter todos os dados da entidade Transaction.

company.cashOut

Será enviado quando um pagamento Pix ou um Saque/Transferência for realizado no sistema.

company.verifyDocuments

Informações de atualização do status de aprovação de conta

chargeback.update

Será enviado quando uma abertura de disputa for criada no sistema. Vai conter todos os dados da entidade Chargeback, além de conter alguns dados da entidade Transaction e PaymentBill.

company.internalTransfer

Será enviado quando uma transferência interna for realizada. Vai conter todos os dados da entidade Transaction.

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

URL alterada com sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.