Skip to main content
Use this endpoint to inspect your current webhook configuration. The response includes the URL registered to receive transaction event notifications and its active status. This is useful for verifying that your webhook is correctly set up before testing a payment flow, or for confirming what endpoint is on record after making changes via POST /api/webhooks/upsert.

​
Endpoint

GET https://v2.certopaybrasil.com/api/webhooks

​
Authentication

All requests must include your secret API key in the X-Api-Key header.
​
X-Api-Key
string
required
Your CertoPay secret API key (e.g. sk_live_sua_chave_aqui).

​
Example Request

curl https://v2.certopaybrasil.com/api/webhooks \
  -H "X-Api-Key: sk_live_sua_chave_aqui"

​
Response

Returns the webhook configuration object for your account, including the registered URL and its current status.

​
200 — Success

{
  "id": "uuid-do-webhook",
  "url": "https://seusite.com/webhooks/certopay",
  "status": "ACTIVE",
  "createdAt": "2026-06-20T08:00:00Z",
  "updatedAt": "2026-06-26T09:00:00Z"
}

​
Response Fields

​
id
string
Unique identifier (UUID) for your webhook configuration.
​
url
string
The HTTPS URL currently registered to receive transaction event notifications.
​
status
string
Current status of the webhook. ACTIVE means notifications are being delivered; INACTIVE means the webhook has been disabled.
​
createdAt
string
ISO 8601 timestamp for when the webhook was first registered.
​
updatedAt
string
ISO 8601 timestamp for when the webhook configuration was last modified.
If no webhook has been registered for your account, this endpoint may return a 404 or an empty response. Use POST /api/webhooks/upsert to register a URL and begin receiving notifications.