Tipos de eventos

Os webhooks Ignite suportam três tipos de evento para o ciclo de vida dos vídeos. Podes subscrever qualquer combinação destes eventos ao criar uma subscrição de webhook.

Eventos disponíveis

`video.created`

Disparado quando um novo vídeo é criado no teu workspace.

Quando ocorre:

É criado um novo objeto de vídeo via API
É carregado um vídeo através da interface de administração

Payload: O objeto de vídeo completo com todos os valores iniciais. Nota: o status do vídeo pode ser NO_FILE ou PROCESSING nesta fase.

`video.updated`

Disparado quando qualquer propriedade de um vídeo é alterada.

Quando ocorre:

Os metadados do vídeo são atualizados (título, descrição, visibilidade, etc.)
O processamento do vídeo conclui (o estado passa a COMPLETE)
São adicionadas ou alteradas faixas de texto ou capítulos
São alteradas categorias ou tags
A miniatura é atualizada

Payload: O objeto de vídeo completo com todos os valores atuais após a atualização.

`video.deleted`

Disparado quando um vídeo é eliminado do teu workspace.

Quando ocorre:

Um vídeo é eliminado via API
Um vídeo é eliminado através da interface de administração

Payload: O objeto de vídeo completo tal como existia antes da eliminação.

Estrutura do payload dos eventos

Todos os eventos entregam o objeto de vídeo completo como corpo do pedido. O tipo de evento é indicado no cabeçalho X-Webhook-Event, não no corpo.

Exemplo: video.created

Cabeçalhos:


POST /your-webhook-endpoint HTTP/1.1
Content-Type: application/json
X-Webhook-Event: video.created
X-Webhook-Signature: t=1705316400000,v1=abc123...
X-Webhook-Delivery-Id: del_507f1f77bcf86cd799439011

Corpo:


{
  "id": "507f1f77bcf86cd799439011",
  "status": "PROCESSING",
  "visibility": "private",
  "title": "My New Video",
  "description": "",
  "duration": 0,
  "workspace": "507f1f77bcf86cd799439000",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Exemplo: video.updated

Cabeçalhos:


POST /your-webhook-endpoint HTTP/1.1
Content-Type: application/json
X-Webhook-Event: video.updated
X-Webhook-Signature: t=1705316500000,v1=def456...
X-Webhook-Delivery-Id: del_507f1f77bcf86cd799439012

Corpo:


{
  "id": "507f1f77bcf86cd799439011",
  "status": "COMPLETE",
  "visibility": "public",
  "title": "My New Video",
  "description": "A great video about something",
  "duration": 120,
  "fps": 30,
  "orientation": "landscape",
  "src": {
    "thumbnails": [
      {
        "name": "1080p", "width": 1920, "height": 1080,
        "formats": {
          "jpeg": { "url": "https://cdn.ignite.video/.../a1b2c3d4-1080p.jpg", "fileSize": 9180 },
          "webp": { "url": "https://cdn.ignite.video/.../a1b2c3d4-1080p.webp", "fileSize": 4256 }
        }
      },
      // ... additional resolutions
    ],
    "thumbnailUrl": "https://cdn.ignite.video/.../a1b2c3d4-1080p.jpg",
    "abr": {
      "resolution": "auto",
      "description": "Adaptive Bitrate Streaming (ABR)",
      "url": "https://cdn.ignite.video/.../master.m3u8",
      "maxWidth": 1920,
      "maxHeight": 1080
    },
    "hls": [...],
    "mp4": [...]
  },
  "workspace": "507f1f77bcf86cd799439000",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:35:00.000Z"
}

Exemplo: video.deleted

Cabeçalhos:


POST /your-webhook-endpoint HTTP/1.1
Content-Type: application/json
X-Webhook-Event: video.deleted
X-Webhook-Signature: t=1705316600000,v1=ghi789...
X-Webhook-Delivery-Id: del_507f1f77bcf86cd799439013

Corpo:


{
  "id": "507f1f77bcf86cd799439011",
  "status": "COMPLETE",
  "visibility": "public",
  "title": "My New Video",
  "description": "A great video about something",
  "duration": 120,
  "workspace": "507f1f77bcf86cd799439000",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:35:00.000Z"
}

Boas práticas

Tratar todos os eventos subscritos

Verifica sempre o cabeçalho X-Webhook-Event e trata cada tipo de evento de forma adequada:


const eventType = request.headers['x-webhook-event'];
 
switch(eventType) {
  case 'video.created':
    // Handle new video
    break;
  case 'video.updated':
    // Handle video update
    break;
  case 'video.deleted':
    // Handle video deletion
    break;
  default:
    console.log('Unknown event type:', eventType);
}

Usar o ID de entrega para idempotência

O cabeçalho X-Webhook-Delivery-Id contém um identificador único para cada entrega de webhook. Guarda os IDs de entrega já processados para evitar processamento duplicado em caso de novas tentativas:


const deliveryId = request.headers['x-webhook-delivery-id'];
 
if (await hasBeenProcessed(deliveryId)) {
  return res.status(200).json({ received: true, duplicate: true });
}
 
// Process the event...
await markAsProcessed(deliveryId);