Configurar Webhook.

PUT

/webhookcobr

WebhookCobR

Endpoint para configuração do serviço de notificações acerca de cobranças recorrentes. Somente cobranças recorrentes associadas ao usuário recebedor serão notificadas.

Callbacks

cobr

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

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

Token URL: /oauth/token

Scopes:

webhookcobr.write-Permissão para alteração do webhook

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

Webhook para notificações.

Esta resposta não possui corpo.

🟠400

🟠403AcessoNegado

🟠404NaoEncontrado

🔴503ServicoIndisponivel

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/webhookcobr' \
--header 'Content-Type: application/json' \
--data '{
    "webhookUrl": "https://usuario.recebedor.com/api/webhookcobr/"
}'

Response Example

400 - Exemplo de erro da requisição 1

{
    "type": "https://pix.bcb.gov.br/api/v2/error/WebhookOperacaoInvalida",
    "title": "Webhook inválido.",
    "status": 400,
    "detail": "A presente requisição busca criar um webhook sem respeitar o _schema_ ou, ainda, com sentido semanticamente inválido."
}

Página anterior

Exibir informações acerca do Webhook.

Próxima página

WebhookPixBody