Skip to main content
POST
Criar webhook
Informe webhook_url e events (ao menos um). Opcionalmente envie hmac_secret (mínimo 16 e máximo 256 caracteres) para autenticação HMAC nas entregas. Cada conta pode ter no máximo 10 endpoints de webhook ativos. O secret nunca é devolvido na resposta.

Authorizations

client-id
string
header
required
client-secret
string
header
required

Headers

client-id
string
required

ID público da credencial do merchant

client-secret
string
required

Secret da credencial do merchant

Body

application/json
webhook_url
string<uri>
required

URL HTTPS que receberá as notificações via POST

Pattern: ^https://.+
Example:

"https://minhaloja.com.br/webhooks/uvvipay"

events
enum<string>[]
required

Eventos em que o endpoint será inscrito

Minimum array length: 1
Available options:
transaction.status.updated,
transaction.waiting_payment,
transaction.paid,
transaction.refused,
transaction.refunded,
transaction.chargedback,
transaction.cancelled,
transaction.expired,
transaction.in_analysis,
submerchant.status.updated,
subscription.created,
subscription.trial_started,
subscription.activated,
subscription.past_due,
subscription.cancelled,
subscription.reactivated,
subscription.completed,
subscription.renewed
Example:
hmac_secret
string | null

Secret HMAC opcional usado para assinar as entregas (X-UvviPay-Timestamp + X-UvviPay-Signature sobre timestamp.body). Nunca é devolvido nas respostas.

Required string length: 16 - 256
Example:

"seu-segredo-compartilhado"

Response

Webhook criado com sucesso

data
object