Testar conectividade de uma URL

POST

/api/v2/webhooks/subscriptions/test

Dispara um POST de teste (event_type: webhook.test) na URL informada e
retorna o resultado — útil pra validar o receptor ANTES de criar a assinatura.

O corpo enviado segue o envelope padrão, mas sem assinatura HMAC
(não há secret ainda). reachable: true = sua URL respondeu 2xx em até 10s.

Mesmas validações de URL do create (HTTPS, IP público).

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Resultado do teste de conectividade.

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v2/webhooks/subscriptions/test' \
--header 'api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://erp.suaempresa.com.br/atendimento/webhook"
}'

Response Example

URL OK

{
    "ok": true,
    "code": 200,
    "data": {
        "reachable": true,
        "response_status": 200,
        "response_body": "{\"received\":true}"
    }
}

Modificado em 2026-11-04 02:53:16

Página anterior

Criar webhook (o secret aparece UMA única vez)

Próxima página

Detalhar webhook