Skip to main content
POST
/
v1
/
webhook
Criar webhook
curl --request POST \
  --url https://api.valorapayments.com.br/v1/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://meusite.com.br/webhooks/valora",
  "events": [
    "payment.confirmed",
    "payment.failed",
    "payment.expired"
  ]
}
'
{
  "webhook_id": "wh_a1b2c3d4",
  "business_id": "<string>",
  "url": "<string>",
  "events": [],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Chave de API gerada no painel Valora. Envie em todas as requisições.

Body

application/json
​
url
string<uri>
required

URL HTTPS que receberá os eventos via POST

Example:

"https://meusite.com.br/webhooks/valora"

​
events
enum<string>[]
required

Lista de eventos a monitorar

Eventos disponíveis para assinatura

Available options:
payment.created,
payment.confirmed,
payment.expired,
payment.failed
Example:
["payment.confirmed", "payment.failed"]

Response

Webhook criado

​
webhook_id
string
Example:

"wh_a1b2c3d4"

​
business_id
string
​
url
string<uri>
​
events
enum<string>[]

Eventos disponíveis para assinatura

Available options:
payment.created,
payment.confirmed,
payment.expired,
payment.failed
​
status
enum<string>
Available options:
active,
inactive
​
created_at
string<date-time>
​
updated_at
string<date-time>