Tipi di eventi

I webhook Ignite supportano tre tipi di evento per il ciclo di vita del video. Puoi iscriverti a qualsiasi combinazione di questi eventi quando crei una sottoscrizione webhook.

Eventi disponibili

`video.created`

Si attiva quando nel tuo workspace viene creato un nuovo video.

Quando scatta:

Viene creato un nuovo oggetto video tramite l’API
Un video viene caricato dall’Admin UI

Payload: L’intero oggetto video con tutti i valori iniziali. Nota che lo status del video può essere NO_FILE o PROCESSING in questo momento.

`video.updated`

Si attiva quando viene modificata una qualsiasi proprietà di un video.

Quando scatta:

I metadati del video vengono aggiornati (titolo, descrizione, visibilità, ecc.)
L’elaborazione del video termina (lo status passa a COMPLETE)
Vengono aggiunte o modificate tracce di testo o capitoli
Cambiano categorie o tag
Viene aggiornata la miniatura

Payload: L’intero oggetto video con tutti i valori correnti dopo l’aggiornamento.

`video.deleted`

Si attiva quando un video viene eliminato dal tuo workspace.

Quando scatta:

Un video viene eliminato tramite l’API
Un video viene eliminato dall’Admin UI

Payload: L’intero oggetto video com’era prima dell’eliminazione.

Struttura del payload degli eventi

Tutti gli eventi recapitano l’intero oggetto video come corpo della richiesta. Il tipo di evento è indicato nell’intestazione X-Webhook-Event, non nel corpo.

Esempio: video.created

Intestazioni:


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"
}

Esempio: video.updated

Intestazioni:


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"
}

Esempio: video.deleted

Intestazioni:


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"
}

Buone pratiche

Gestire tutti gli eventi a cui sei iscritto

Controlla sempre l’intestazione X-Webhook-Event e gestisci ogni tipo di evento in modo appropriato:


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);
}

Usare l’ID di consegna per l’idempotenza

L’intestazione X-Webhook-Delivery-Id contiene un identificatore univoco per ogni consegna webhook. Memorizza gli ID di consegna già elaborati per evitare elaborazioni duplicate in caso di nuovi tentativi:


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);