Criar webhook para cobranças (invoices).

POST

/webhooks/invoice

Webhooks

Cadastra a URL que recebe eventos de cobrança: invoice.registered, invoice.paid, invoice.settled, invoice.cancelled e invoice.overdue.

Callbacks

notification

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:

webhook.write-Permite cadastrar, alterar ou remover webhooks

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Criado

Bodyapplication/json

🟠400

🟠401

🟠403

🟠409

🟠429

🔴500

🔴503

🔴504

Request Example

Shell

JavaScript

Java

Swift

curl --location '/webhooks/invoice' \
--header 'Content-Type: application/json' \
--data '{
    "uri": "http://example.com",
    "email": "string",
    "method": "POST",
    "enabled": true,
    "pauseOnFail": true,
    "headers": {
        "headerName": "string"
    }
}'

Response Example

201 - Exemplo de webhook de cobrança

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "INVOICE",
    "uri": "https://example.com/webhook",
    "enabled": true
}

Página anterior

Criar webhook para falhas em operações de saída.

Próxima página

Criar webhook para eventos CaaS (carteiras e ordens).