Webhooks

Os webhooks entregam notificações HTTP POST em tempo real quando as tarefas assíncronas em segundo plano são concluídas, como a publicação bem-sucedida de postagens, falhas ou envios de respostas.

📌 Endpoints

Método	Caminho	Descrição	Escopo Necessário
`POST`	`/v1/brand/webhooks`	Registra um novo endpoint de webhook	`webhooks:write` ou `*`
`GET`	`/v1/brand/webhooks`	Lista as assinaturas de webhook registradas	`webhooks:read` ou `*`
`DELETE`	`/v1/brand/webhooks/{webhook_id}`	Exclui uma assinatura de webhook	`webhooks:write` ou `*`

🔔 Tipos de Eventos Suportados

Nome do Evento	Condição de Acionamento
`sns.publish.succeeded`	Postagem publicada com sucesso na rede social de destino
`sns.publish.failed`	Falha na publicação da postagem (inclui código de erro e elegibilidade para nova tentativa)
`sns.publish.blocked_entitlement`	Publicação bloqueada devido a limites de cota ou plano expirado
`sns.reply.succeeded`	Comentário de resposta postado com sucesso
`sns.reply.failed`	Falha no envio do comentário de resposta
`sns.provider.notification_received`	Webhook em tempo real recebido de um provedor de SNS externo

📦 Exemplo de Payload de Webhook (`sns.publish.succeeded`)

{
  "event_id": "evt_01jm8za2example",
  "event_type": "sns.publish.succeeded",
  "schema_version": 1,
  "occurred_at": "2026-08-16T03:30:00Z",
  "brand_ref": "brand_01jm8v4k9example",
  "trace_id": "trc_9a8b7c6d",
  "data": {
    "content_id": "content_01jm8za2example",
    "publish_job_id": "job_01jm8za2jobexample",
    "sns_type": "instagram",
    "connection_id": "conn_01jm8x9k2example",
    "provider_post_id": "18029384756102938",
    "status": "succeeded"
  }
}

🔐 Verificação de Assinatura (HMAC SHA256)

As requisições de webhook incluem cabeçalhos de verificação personalizados:

Social-Webhook-Signature: Payload da assinatura (v1=hex_signature)
Social-Webhook-Timestamp: Timestamp Unix em segundos
Social-Webhook-Id: Identificador de entrega

Verificação em Node.js (Crypto)

import crypto from 'node:crypto';

export function verifyWebhookSignature(rawBody: string, signatureHeader: string, timestampHeader: string, secret: string): boolean {
  const signedPayload = `${timestampHeader}.${rawBody}`;
  const expectedSignature = crypto.createHmac('sha256', secret).update(signedPayload).digest('hex');

  const actual = Buffer.from(signatureHeader);
  const expected = Buffer.from(`v1=${expectedSignature}`);
  return actual.length === expected.length && crypto.timingSafeEqual(actual, expected);
}

Verificação em Python (hmac)

import hmac
import hashlib

def verify_webhook_signature(raw_body: bytes, signature: str, timestamp: str, secret: str) -> bool:
    signed_payload = f"{timestamp}.".encode('utf-8') + raw_body
    expected = hmac.new(secret.encode('utf-8'), signed_payload, hashlib.sha256).hexdigest()
    return hmac.compare_digest(signature, f"v1={expected}")

[!CAUTION] A verificação da assinatura deve usar o corpo da requisição bruto não analisado (raw body).

🔗 Documentação Relacionada