Skip to main content
GET
/
webhooks
/
get
Buscar um webhook
curl --request GET \
  --url https://api.abacatepay.com/v2/webhooks/get \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "webh_abc123xyz",
    "name": "Webhook de Pagamentos",
    "endpoint": "https://meusite.com/webhooks/abacatepay",
    "events": [
      "checkout.completed",
      "subscription.renewed"
    ],
    "devMode": false,
    "v2": true,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  },
  "error": null,
  "success": true
}

Requer a permissão WEBHOOK:READ.

Authorizations

​
Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

​
id
string
required

Identificador único do webhook

Example:

"webh_abc123xyz"

Response

Webhook encontrado com sucesso.

​
data
object

Os dados do webhook.

​
error
string | null
Example:

null

​
success
boolean

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

Example:

true