Webhooks
Endpoints que recebem eventos do gateway.
- GET/v1/webhook-endpoints · Listar endpoints de webhook
- POST/v1/webhook-endpoints · Cadastrar endpoint de webhook
- PATCH/v1/webhook-endpoints/{webhook_endpoint_id} · Alterar endpoint de webhook
- DELETE/v1/webhook-endpoints/{webhook_endpoint_id} · Remover endpoint de webhook
- POST/v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret · Trocar o segredo do endpoint
- POST/v1/webhook-endpoints/{webhook_endpoint_id}/test · Enviar evento de teste
Listar endpoints de webhook
GET/v1/webhook-endpoints
Resposta
- datalista de object
- —
- data[].idobrigatóriostring
- —
- data[].urlobrigatóriostring
- —
- data[].eventsobrigatóriolista de charge.created | charge.updated | charge.paid | charge.overdue | charge.expired | charge.canceled | charge.failed | charge.refunded | charge.dispute_opened | charge.chargeback | charge.settled | payment_link.created | payment_link.paid | payment_link.expired | payment_link.canceled | connection.pending | connection.awaiting_enablement | connection.active | connection.revoked | account.updated | partner.statement_closed
- —
- data[].enabledobrigatórioboolean
- —
- data[].descriptionstring ou nulo
- —
- data[].last_deliveryobject ou nulo
- —
- data[].last_delivery.atstring
- —
- data[].last_delivery.http_statusinteger ou nulo
- —
- data[].last_delivery.succeededboolean
- —
- data[].created_atobrigatóriostring
- —
Códigos de resposta
- 200 Endpoints.
- 401 Chave ausente, inválida ou revogada.
Cadastrar endpoint de webhook
POST/v1/webhook-endpoints
O secret é devolvido só nesta resposta. Guarde para validar a assinatura.
Parâmetros
- Idempotency-Keystring · cabeçalho
Até 255 caracteres. Mesma chave em 24 horas devolve a mesma resposta.
Corpo da requisição (JSON)
- urlobrigatóriostring
HTTPS obrigatório em produção.
- eventsobrigatóriolista de charge.created | charge.updated | charge.paid | charge.overdue | charge.expired | charge.canceled | charge.failed | charge.refunded | charge.dispute_opened | charge.chargeback | charge.settled | payment_link.created | payment_link.paid | payment_link.expired | payment_link.canceled | connection.pending | connection.awaiting_enablement | connection.active | connection.revoked | account.updated | partner.statement_closed
- —
- descriptionstring
- —
Resposta
- idobrigatóriostring
- —
- urlobrigatóriostring
- —
- eventsobrigatóriolista de charge.created | charge.updated | charge.paid | charge.overdue | charge.expired | charge.canceled | charge.failed | charge.refunded | charge.dispute_opened | charge.chargeback | charge.settled | payment_link.created | payment_link.paid | payment_link.expired | payment_link.canceled | connection.pending | connection.awaiting_enablement | connection.active | connection.revoked | account.updated | partner.statement_closed
- —
- enabledobrigatórioboolean
- —
- descriptionstring ou nulo
- —
- last_deliveryobject ou nulo
- —
- last_delivery.atstring
- —
- last_delivery.http_statusinteger ou nulo
- —
- last_delivery.succeededboolean
- —
- created_atobrigatóriostring
- —
- secretobrigatóriostring
Segredo HMAC, prefixo
whsec_.
Códigos de resposta
- 201 Endpoint criado.
- 400 Parâmetro ausente ou inválido.
Alterar endpoint de webhook
PATCH/v1/webhook-endpoints/{webhook_endpoint_id}
Corpo da requisição (JSON)
- urlstring
- —
- eventslista de charge.created | charge.updated | charge.paid | charge.overdue | charge.expired | charge.canceled | charge.failed | charge.refunded | charge.dispute_opened | charge.chargeback | charge.settled | payment_link.created | payment_link.paid | payment_link.expired | payment_link.canceled | connection.pending | connection.awaiting_enablement | connection.active | connection.revoked | account.updated | partner.statement_closed
- —
- enabledboolean
- —
- descriptionstring
- —
Resposta
- idobrigatóriostring
- —
- urlobrigatóriostring
- —
- eventsobrigatóriolista de charge.created | charge.updated | charge.paid | charge.overdue | charge.expired | charge.canceled | charge.failed | charge.refunded | charge.dispute_opened | charge.chargeback | charge.settled | payment_link.created | payment_link.paid | payment_link.expired | payment_link.canceled | connection.pending | connection.awaiting_enablement | connection.active | connection.revoked | account.updated | partner.statement_closed
- —
- enabledobrigatórioboolean
- —
- descriptionstring ou nulo
- —
- last_deliveryobject ou nulo
- —
- last_delivery.atstring
- —
- last_delivery.http_statusinteger ou nulo
- —
- last_delivery.succeededboolean
- —
- created_atobrigatóriostring
- —
Códigos de resposta
- 200 Endpoint alterado.
- 404 Recurso não encontrado para esta chave.
Remover endpoint de webhook
DELETE/v1/webhook-endpoints/{webhook_endpoint_id}
Códigos de resposta
- 204 Removido.
- 404 Recurso não encontrado para esta chave.
Trocar o segredo do endpoint
POST/v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret
O segredo anterior continua válido por 24 horas.
Parâmetros
- webhook_endpoint_idobrigatóriostring · caminho
- —
Resposta
- secretobrigatóriostring
- —
Códigos de resposta
- 200 Novo segredo.
- 401 Chave ausente, inválida ou revogada.
Enviar evento de teste
POST/v1/webhook-endpoints/{webhook_endpoint_id}/test
Parâmetros
- webhook_endpoint_idobrigatóriostring · caminho
- —
Corpo da requisição (JSON)
- typecharge.created | charge.updated | charge.paid | charge.overdue | charge.expired | charge.canceled | charge.failed | charge.refunded | charge.dispute_opened | charge.chargeback | charge.settled | payment_link.created | payment_link.paid | payment_link.expired | payment_link.canceled | connection.pending | connection.awaiting_enablement | connection.active | connection.revoked | account.updated | partner.statement_closed
- —
Códigos de resposta
- 202 Evento de teste enfileirado.
- 401 Chave ausente, inválida ou revogada.