curl -X GET "https://api.zeriqpay.com.br/v1/webhooks/get/cmid_webhook" \
-H "X-API-Key: zeriq_sua_chave"
{"success":true,"data":{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid"],"active":true,"lastDeliveryAt":null,"createdAt":"2026-10-28T12:00:00.000Z","updatedAt":"2026-10-28T12:00:00.000Z"}}
Gerenciamento
Consultar endpoint de webhook
Consulta um endpoint por ID
GET
/
v1
/
webhooks
/
get
/
{id}
curl -X GET "https://api.zeriqpay.com.br/v1/webhooks/get/cmid_webhook" \
-H "X-API-Key: zeriq_sua_chave"
{"success":true,"data":{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid"],"active":true,"lastDeliveryAt":null,"createdAt":"2026-10-28T12:00:00.000Z","updatedAt":"2026-10-28T12:00:00.000Z"}}
Retorna a configuração de um endpoint específico, sem expor o segredo.
Autenticação
Todas as rotas exigem uma API Key no headerX-API-Key. A chave deve começar com zeriq_.
X-API-Key: zeriq_sua_chave
curl -X GET "https://api.zeriqpay.com.br/v1/webhooks/get/cmid_webhook" \
-H "X-API-Key: zeriq_sua_chave"
Parâmetro de rota
id: identificador CUID do endpoint.
Referência
- Método:
GET - Rota:
/v1/webhooks/get/{id} - Escopo:
webhooks.read - Resposta de sucesso:
200 OK
id é o identificador retornado na criação ou na listagem.
Exemplo de resposta
{"success":true,"data":{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid"],"active":true,"lastDeliveryAt":null,"createdAt":"2026-10-28T12:00:00.000Z","updatedAt":"2026-10-28T12:00:00.000Z"}}
Erros comuns
400: URL, eventos ou body inválidos.401: API Key ausente ou inválida.403: a chave não possui o escopowebhooks.read.404: endpoint não encontrado ou não pertence à conta.