Skip to main content
GET
/
v1
/
webhooks
/
{id}
Retrieve a Specific Webhook Subscription
curl --request GET \
  --url https://conta-public-api.kiwify.com/v1/webhooks/{id} \
  --header 'X-PoP-Challenge: <api-key>' \
  --header 'X-PoP-Format: <api-key>' \
  --header 'X-PoP-Signature: <api-key>' \
  --header 'x-access-id: <api-key>'
{
  "id": "6225875037061120",
  "subscriptions": [
    "CASHIN.PIX.QRCODES"
  ],
  "url": "https://empresa.com/empresa_webhook"
}

Authorizations

​
x-access-id
string
header
required

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

​
X-PoP-Challenge
string
header
required

Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5 minutes of server time.

​
X-PoP-Format
string
header
required

Must be 'service-account' for service account authentication

​
X-PoP-Signature
string
header
required

EdDSA signature of the request in base64 format. Signs: uri:method:body:timestamp

Path Parameters

​
id
integer<int64>
required

Webhook subscription ID

Response

Webhook subscription details

Webhook subscription representation.

​
id
string
required

Unique identifier of the webhook subscription.

Example:

"6225875037061120"

​
subscriptions
enum<string>[]
required

List of event types this webhook is subscribed to.

Event type to subscribe to for webhook notifications.

Each webhook subscription can listen to multiple event types. Events are sent as HTTP POST requests to the registered endpoint URL.

Available options:
CASHIN.PIX.QRCODES,
CASHIN.DEPOSITS,
CASHOUT.PIX.TRANSFERS,
CASHOUT.PIX.REFUNDS,
CASHOUT.BOLETO.PAYMENTS,
CASHOUT.PIX.QRCODE.PAYMENTS
​
url
string
required

The endpoint URL registered to receive webhook events.

Example:

"https://empresa.com/empresa_webhook"