Skip to content

Commit

Permalink
Fix webhook event table formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@szekelyzol
szekelyzol committed Nov 13, 2024
1 parent 176e414 commit 0a64598
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions reference/create-and-manage-webhooks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ Here’s how the webhook flow looks like, using `video.encoding` as an example:

These are the available webhook events:

| Event | Triggers when... |
|-:------------------------------------------------------------------------------|-:----------------------------------------------------------------------------------------------------------------------------------------------------|
| [`live-stream.broadcast.started`](/reference/api/Webhooks#live-stream-started) | A live stream broadcast has started. |
| [`live-stream.broadcast.ended`](/reference/api/Webhooks#live-stream-ended) | A live stream broadcast has ended. |
| [`video.source.recorded`](/reference/api/Webhooks#video-source-recorded) | A live stream has been completed and the recording of the live stream is ready to be transcoded. This means that the video in queue for transcoding. |
| [`video.encoding.quality.completed`](/reference/api/Webhooks#video-encoding-completed) | A set quality version of encoding is complete for a video that you uploaded.<br /><br />For each video, the MP4 asset is transcoded only once, hence you only receive one webhook notification for the MP4 asset, with the final source quality. The HLS asset's webhook notification triggers multiple times with each quality from the lowest 240p to the highest, up to 4k, based on the source you uploaded.<br /><br />For example, if you upload a video in 720p quality, you receive 5 webhooks in total:<br /><br />- **1 webhook** with 720p quality for the MP4 encoding<br />- **4 webhooks** for 240p, 360p, 480p, and 720p for the HLS encoding. |
| [`video.caption.generated`](/reference/api/Webhooks#video-caption-generated) | An automatic caption has been generated. |
| [`video.summary.generated`](/reference/api/Webhooks#video-summary-generated) | An automatic summary has been generated. |
| Event | Triggers when... |
|----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`live-stream.broadcast.started`](/reference/api/Webhooks#live-stream-started) | A live stream broadcast has started. |
| [`live-stream.broadcast.ended`](/reference/api/Webhooks#live-stream-ended) | A live stream broadcast has ended. |
| [`video.source.recorded`](/reference/api/Webhooks#video-source-recorded) | A live stream has been completed and the recording of the live stream is ready to be transcoded. This means that the video in queue for transcoding. |
| [`video.encoding.quality.completed`](/reference/api/Webhooks#video-encoding-completed) | A set quality version of encoding is complete for a video that you uploaded.<br /><br />For each video, the MP4 asset is transcoded only once, hence you only receive one webhook notification for the MP4 asset, with the final source quality. The HLS asset's webhook notification triggers multiple times with each quality from the lowest 240p to the highest, up to 4k, based on the source you uploaded.<br /><br />For example, if you upload a video in 720p quality, you receive 5 webhooks in total:<br /><br />- **1 webhook** with 720p quality for the MP4 encoding<br />- **4 webhooks** for 240p, 360p, 480p, and 720p for the HLS encoding. |
| [`video.caption.generated`](/reference/api/Webhooks#video-caption-generated) | An automatic caption has been generated. |
| [`video.summary.generated`](/reference/api/Webhooks#video-summary-generated) | An automatic summary has been generated. |

Check out the [API reference](/reference/api/Webhooks) for detailed descriptions of each webhook event's request headers and payloads.

Expand Down

0 comments on commit 0a64598

Please sign in to comment.