Skip to content

Webhooks

Envie notificações de webhook HTTP assinadas com HMAC a partir do Potato para 7 tipos de eventos de anotação — com retry de backoff exponencial, monitoramento de admin e verificação em Python/Node.

Novo na v2.4.0

Os webhooks permitem que o Potato notifique sistemas externos quando eventos de anotação ocorrem — sem polling. Conecte-se a pipelines de dados, dispare alertas, atualize dashboards ou inicie o processamento posterior automaticamente.

Visão Geral

O Potato envia uma requisição HTTP POST ao seu endpoint configurado sempre que um evento suportado é disparado. Os payloads são JSON e assinados com HMAC-SHA256 para que você possa verificar que vieram da sua instância do Potato.

A entrega de webhooks é totalmente não bloqueante — as requisições de anotação nunca são atrasadas enquanto os webhooks estão em trânsito. Entregas com falha são repetidas com backoff exponencial.

Configuração

Adicione uma seção webhooks à sua configuração YAML:

yaml
webhooks:
  enabled: true
  endpoints:
    - name: "my-pipeline"
      url: "https://your-system.example.com/potato-events"
      secret: "your-signing-secret"        # optional but recommended
      events:
        - annotation.created
        - item.fully_annotated
        - task.completed
      active: true
      timeout: 10

Múltiplos Endpoints

Você pode configurar múltiplos endpoints, cada um com diferentes assinaturas de eventos:

yaml
webhooks:
  enabled: true
  endpoints:
    - name: "data-pipeline"
      url: "https://pipeline.example.com/annotations"
      secret: ${WEBHOOK_SECRET_1}
      events:
        - annotation.created
        - item.fully_annotated
    - name: "slack-alerts"
      url: "https://hooks.slack.com/services/..."
      events:
        - task.completed
        - quality.attention_check_failed
    - name: "catch-all"
      url: "https://logging.example.com/potato"
      events:
        - "*"          # subscribe to all events

Tipos de Evento

EventoDispara Quando
annotation.createdUm anotador envia um rótulo para uma instância
annotation.updatedUm anotador modifica um rótulo enviado anteriormente
item.fully_annotatedUma instância atinge sua contagem de sobreposição de anotações exigida
task.completedTodas as instâncias da tarefa foram totalmente anotadas
user.phase_completedUm anotador completa uma fase (fluxo do Modo Solo)
quality.attention_check_failedUm anotador falha em uma verificação de atenção
webhook.testDisparado manualmente pela API de admin para testes

Use "*" para assinar todos os tipos de evento atuais e futuros.

Formato do Payload

Todos os eventos compartilham um envelope comum:

json
{
  "event_id": "evt_01HXYZ...",
  "event_type": "annotation.created",
  "timestamp": "2026-03-17T14:23:01Z",
  "task_name": "sentiment-study",
  "data": {
    ...
  }
}

Payload de annotation.created

json
{
  "event_type": "annotation.created",
  "data": {
    "annotator_id": "user123",
    "instance_id": "doc_042",
    "annotation": {
      "sentiment": "positive",
      "confidence": "high"
    },
    "submitted_at": "2026-03-17T14:23:01Z"
  }
}

Payload de item.fully_annotated

json
{
  "event_type": "item.fully_annotated",
  "data": {
    "instance_id": "doc_042",
    "annotator_count": 3,
    "annotations": [
      {"annotator_id": "user1", "sentiment": "positive"},
      {"annotator_id": "user2", "sentiment": "positive"},
      {"annotator_id": "user3", "sentiment": "neutral"}
    ]
  }
}

Payload de task.completed

json
{
  "event_type": "task.completed",
  "data": {
    "task_name": "sentiment-study",
    "total_instances": 500,
    "total_annotations": 1500,
    "completed_at": "2026-03-17T15:00:00Z"
  }
}

Verificando Assinaturas

Quando um secret está configurado, o Potato assina cada requisição usando Standard Webhooks (HMAC-SHA256). Três cabeçalhos são incluídos:

CabeçalhoValor
webhook-idID único da entrega
webhook-timestampTimestamp Unix da entrega
webhook-signatureAssinatura HMAC-SHA256

Verificação em Python

python
import hmac
import hashlib
import time
 
def verify_webhook(payload_bytes: bytes, headers: dict, secret: str) -> bool:
    webhook_id = headers.get("webhook-id", "")
    timestamp = headers.get("webhook-timestamp", "")
    signature = headers.get("webhook-signature", "")
 
    # Reject stale requests (older than 5 minutes)
    if abs(time.time() - int(timestamp)) > 300:
        return False
 
    signed_content = f"{webhook_id}.{timestamp}.{payload_bytes.decode()}"
    expected = hmac.new(
        secret.encode(),
        signed_content.encode(),
        hashlib.sha256
    ).hexdigest()
 
    return hmac.compare_digest(f"v1,{expected}", signature)

Verificação em Node.js

javascript
const crypto = require('crypto');
 
function verifyWebhook(payload, headers, secret) {
  const webhookId = headers['webhook-id'];
  const timestamp = headers['webhook-timestamp'];
  const signature = headers['webhook-signature'];
 
  // Reject stale requests
  if (Math.abs(Date.now() / 1000 - parseInt(timestamp)) > 300) {
    return false;
  }
 
  const signedContent = `${webhookId}.${timestamp}.${payload}`;
  const expected = crypto
    .createHmac('sha256', secret)
    .update(signedContent)
    .digest('hex');
 
  return crypto.timingSafeEqual(
    Buffer.from(`v1,${expected}`),
    Buffer.from(signature)
  );
}

Comportamento de Retry

Entregas com falha (resposta não-2xx ou timeout) são repetidas automaticamente:

TentativaAtraso
1 (inicial)Imediato
25 segundos
330 segundos
45 minutos
530 minutos
61 hora

Após 6 tentativas com falha, a entrega é marcada como permanentemente com falha. A fila de retry é persistida em SQLite em {output_dir}/.webhooks/webhook_retries.db — os retries pendentes sobrevivem a reinicializações do servidor.

Monitoramento e Testes

API de Admin

Verifique o status e as estatísticas dos webhooks:

bash
# List all webhooks and their delivery statistics
curl -H "X-API-Key: $ADMIN_API_KEY" \
  http://localhost:8000/admin/api/webhooks

Resposta:

json
{
  "endpoints": [
    {
      "name": "my-pipeline",
      "url": "https://...",
      "events": ["annotation.created"],
      "active": true,
      "stats": {
        "total_emitted": 1240,
        "total_failed": 3,
        "pending_retries": 0,
        "last_success": "2026-03-17T14:23:01Z"
      }
    }
  ]
}

Enviar um Webhook de Teste

bash
curl -X POST -H "X-API-Key: $ADMIN_API_KEY" \
  http://localhost:8000/admin/api/webhooks/test \
  -H "Content-Type: application/json" \
  -d '{"endpoint_name": "my-pipeline"}'

Isso dispara imediatamente um evento webhook.test ao endpoint nomeado.

Referência Completa de Configuração

yaml
webhooks:
  enabled: true
  endpoints:
    - name: string           # unique name for this endpoint
      url: string            # HTTPS URL to POST to
      secret: string         # optional HMAC secret for signature verification
      events:                # list of event types, or ["*"] for all
        - annotation.created
      active: true           # set false to disable without removing
      timeout: 10            # request timeout in seconds (default: 10)
      max_retries: 6         # max retry attempts (default: 6)

Leitura Adicional

Para detalhes de implementação, consulte a documentação de origem.