Registrar um endpoint de webhook.
Registra uma URL para a qual o gateway envia via POST eventos assinados de pagamento e de pedido. O secret de assinatura é retornado apenas nesta resposta e nunca mais (armazenado criptografado); faça a rotação para obter um novo. O ambiente (TEST/LIVE) e o seller vêm do escopo da API key, não do body. Exige a permissão webhooks:create. Idempotente via Idempotency-Key.
Registra uma URL para a qual o gateway envia via POST eventos assinados de pagamento e de pedido. O secret de assinatura é retornado apenas nesta resposta e nunca mais (armazenado criptografado); faça a rotação para obter um novo. O ambiente (TEST/LIVE) e o seller vêm do escopo da API key, não do body. Exige a permissão webhooks:create. Idempotente via Idempotency-Key.
Autorização
ApiKeyAuth Em: header
Parâmetros de cabeçalho
1 <= length <= 255Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body em TypeScript.
Corpo da resposta
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhook-endpoints" \ -H "Idempotency-Key: order_123_attempt_1" \ -H "Content-Type: application/json" \ -d '{ "url": "https://api.example.com/bunne/webhooks", "events": [ "charge.paid", "charge.refunded" ], "description": "Order status updates" }'{ "id": "string", "object": "webhook_endpoint", "url": "http://example.com", "description": "string", "environment": "TEST", "events": [ "charge.created" ], "enabled": true, "seller_id": "string", "secret_rotation": { "status": "active", "rotated_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "warned_at": "2019-08-24T14:15:22Z", "grace_ends_at": "2019-08-24T14:15:22Z", "invalidated_at": "2019-08-24T14:15:22Z" }, "created_at": "2019-08-24T14:15:22Z", "secret": "string", "request_id": "req_xxx"}Listar endpoints de webhook. GET
Lista os endpoints de webhook com escopo do tenant/seller para o ambiente da key, dos mais novos para os mais antigos. O secret de assinatura nunca é incluído. Exige a permissão webhooks:read.
Atualizar um endpoint de webhook. PATCH
Edita a url do endpoint e/ou os eventos assinados; ao menos um é obrigatório. O secret, o ambiente e o seller nunca são alterados. Reenviar a mesma url/eventos é um no-op. Exige a permissão webhooks:update.