Pular para o conteúdo principal
POST
/
webhooks
Criar webhook
curl --request POST \
  --url https://api.sandbox.z2pay.com/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "events": [],
  "secret": "<string>"
}
'

Autorizações

​
x-api-key
string
header
obrigatório

API Key da Credential (gerada no Backoffice)

Cabeçalhos

​
Idempotency-Key
string

Chave única para garantir idempotência da requisição

Corpo

application/json
​
name
string
obrigatório
Required string length: 1 - 255
​
url
string<uri>
obrigatório
​
events
enum<string>[]
Opções disponíveis:
transaction.created,
transaction.waiting_payment,
transaction.paid,
transaction.refused,
transaction.failed,
transaction.canceled,
transaction.refunded,
transaction.chargeback,
payment.created,
payment.waiting_payment,
payment.paid,
payment.refused,
payment.failed,
payment.refunded,
payment.chargeback,
customer.created,
customer.updated,
recipient.created,
recipient.updated,
recipient.approved,
recipient.refused,
recipient.deleted,
withdrawal.requested,
withdrawal.paid,
withdrawal.rejected,
invoice.issued,
invoice.payment_attempted,
invoice.paid,
invoice.voided,
invoice.refunded,
invoice.rescheduled,
subscription.created,
subscription.activated,
subscription.canceled,
subscription.cycle_advanced,
subscription.paused,
subscription.resumed
​
secret
string
Minimum string length: 8

Resposta

Webhook criado