Pular para o conteúdo principal
GET
/
v1
/
webhooks
/
{id}
Obter Assinatura de Webhook por ID
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"
}

Autorizações

​
x-access-id
string
header
obrigatório

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

​
X-PoP-Challenge
string
header
obrigatório

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

​
X-PoP-Format
string
header
obrigatório

Must be 'service-account' for service account authentication

​
X-PoP-Signature
string
header
obrigatório

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

Parâmetros de caminho

​
id
integer<int64>
obrigatório

Webhook subscription ID

Resposta

Webhook subscription details

Webhook subscription representation.

​
id
string
obrigatório

Unique identifier of the webhook subscription.

Exemplo:

"6225875037061120"

​
subscriptions
enum<string>[]
obrigatório

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.

Opções disponíveis:
CASHIN.PIX.QRCODES,
CASHIN.DEPOSITS,
CASHOUT.PIX.TRANSFERS,
CASHOUT.PIX.REFUNDS,
CASHOUT.BOLETO.PAYMENTS,
CASHOUT.PIX.QRCODE.PAYMENTS
​
url
string
obrigatório

The endpoint URL registered to receive webhook events.

Exemplo:

"https://empresa.com/empresa_webhook"