OrbitSenderDocs
ReferenceWebhooks

Rotacionar o signing_secret dos webhooks

POST
/api/external/rotate-webhook-secret

Gera um novo signing_secret para os webhooks da conta e o retorna. Owner-only (api-key): apps de parceiro recebem 403. Rotacionar INVALIDA o segredo anterior — atualize o receptor logo em seguida. Se a conta ainda não tem webhooks, o registro (e o segredo) é materializado.

Authorization

ApiKeyAuth
x-api-key<token>

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

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/external/rotate-webhook-secret"
{  "success": true,  "signing_secret": "whsec_..."}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Forbidden",  "message": "Limite de canais atingido.",  "current": 5,  "max": 5}
{  "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."}