OrbitSenderDocs
ReferenceWebhooks

Testar webhook

POST
/api/external/test-webhook/{type}

Dispara um payload de teste para a URL configurada do tipo informado na conta (dono/api-key). Apps de parceiro recebem 403 — eles testam o webhook do próprio app pelo Portal do Desenvolvedor.

Authorization

ApiKeyAuth
x-api-key<token>

Chave de API no formato sk_live_..., no header x-api-key.

In: header

Path Parameters

type*string

Tipo de webhook a testar.

Value in

  • "campaign_status"
  • "campaign_progress"
  • "channel_status"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/external/test-webhook/campaign_status"
{  "success": true,  "message": "string",  "status": 0}
{  "success": false,  "error": "Bad Request",  "message": "O campo \"name\" é obrigatório no body da requisição."}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Too Many Requests",  "code": "rate_limited",  "message": "Muitas requisições. Tente novamente em instantes."}
{  "success": false,  "error": "Internal Server Error",  "message": "Erro interno ao processar a requisição."}
{  "success": false,  "error": "Bad Request",  "code": "bad_request",  "message": "string",  "limitExceeded": true,  "limitType": "string",  "current": 0,  "max": 0}