Criando um webhook

Production

https://api.valut.app/openbank/v1

POST

/webhooks

Elemento	Tipo	Descrição
url	`string`	Url de callback.
events	`Array::string`	Tipo de evento do webhook. "pix_pagar", "pix_receber" ou "boleto_paid"
authorization.type	`string`	Tipo de evento do authorization type. "basic" ou "bearer"
authorization.value	`string`	Valor da autenticação.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Bodyapplication/json

url

string

requerido

events

array[string]

requerido

authorization

null

requerido

Exemplo

{
    "url":"https://webhook.site/11cf9f4d-ac1f-4c60-9bd9-761131735407",
    "events": ["pix_receber", "pix_pagar"],
    "authorization": null
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.valut.app/openbank/v1/webhooks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url":"https://webhook.site/11cf9f4d-ac1f-4c60-9bd9-761131735407",
    "events": ["pix_receber", "pix_pagar"],
    "authorization": null
}'

Respostas

🟢200200 OK

application/json

Body

webhook_id

string

requerido

url

string

requerido

events

array[string]

requerido

has_authorization

boolean

requerido

authorization

object

requerido

type

string

requerido

value

string

requerido

created_at

string

requerido

is_active

boolean

requerido

Exemplo

{
    "webhook_id": "743faa84-0479-4fd3-8e56-94f2349b836a",
    "url": "https://testeauth.brasilcash.com.br",
    "events": [
        "pix_pagar",
        "pix_receber"
    ],
    "has_authorization": true,
    "authorization": {
        "type": "basic",
        "value": "213"
    },
    "created_at": "2022-05-02T16:47:30.8264103-03:00",
    "is_active": true
}

🟠400400 Bad Request

Modificado em 2024-12-09 08:26:00

Página anterior

Pagamento código de barras

Próxima página

Listando webhooks