v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

Criar um webhook

Cria um novo webhook para receber notificações automáticas de eventos da sua loja.

O endpoint deve ser uma URL HTTPS válida e não pode apontar para endereços locais ou IPs privados.

Alternativa: Você também pode criar e gerenciar seus webhooks pelo Dashboard da AbacatePay.

post/webhooks/create

Request body

namestring required

Nome identificador do webhook

endpointstring required

URL HTTPS que receberá as notificações de eventos

secretstring required

Sua chave usada para autenticar nosso webhook

eventsstring[] required

Lista de eventos que este webhook deve receber

Example request

{
  "name": "Webhook de Pagamentos",
  "endpoint": "https://meusite.com/webhooks/abacatepay",
  "secret": "meu-secret-seguro",
  "events": [
    "checkout.completed",
    "subscription.renewed"
  ]
}

Response

Webhook criado com sucesso.

errorstring nullable

successboolean

Se a requisição obteve sucesso ou não.

Example response

{
  "data": {
    "id": "webh_abc123xyz",
    "name": "Webhook de Pagamentos",
    "endpoint": "https://meusite.com/webhooks/abacatepay",
    "events": [
      "checkout.completed",
      "subscription.renewed"
    ],
    "v2": true,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  },
  "success": true
}