Skip to content

Commit 054291f

Browse files
szekelyzolszekelyzol
committed
Merge branch 'add-new-webhooks' of https://github.com/apivideo/api.video-documentation into add-new-webhooks
2 parents 0a64598 + fe573f0 commit 054291f

File tree

1 file changed

+113
-9
lines changed

1 file changed

+113
-9
lines changed

‎openapi.yaml

+113-9
Original file line numberDiff line numberDiff line change
@@ -14362,10 +14362,12 @@ paths:
1436214362
summary: Create Webhook
1436314363
description: |-
1436414364
Webhooks can push notifications to your server, rather than polling api.video for changes. We currently offer four events:
14365-
* ```video.encoding.quality.completed``` Occurs when a new video is uploaded into your account, it will be encoded into several different HLS and mp4 qualities. When each version is encoded, your webhook will get a notification. It will look like ```{ "type": "video.encoding.quality.completed", "emittedAt": "2021-01-29T16:46:25.217+01:00", "videoId": "viXXXXXXXX", "encoding": "hls", "quality": "720p"} ```. This request says that the 720p HLS encoding was completed.
14366-
* ```live-stream.broadcast.started``` When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires.
14367-
* ```live-stream.broadcast.ended``` This event fires when a live stream has finished broadcasting.
14368-
* ```video.source.recorded``` This event occurs when a live stream is recorded and submitted for encoding.
14365+
* `video.encoding.quality.completed` Occurs when a new video is uploaded into your account, it will be encoded into several different HLS and mp4 qualities. When each version is encoded, your webhook will get a notification. It will look like ```{ "type": "video.encoding.quality.completed", "emittedAt": "2021-01-29T16:46:25.217+01:00", "videoId": "viXXXXXXXX", "encoding": "hls", "quality": "720p"} ```. This request says that the 720p HLS encoding was completed.
14366+
* `live-stream.broadcast.started` When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires.
14367+
* `live-stream.broadcast.ended` This event fires when a live stream has finished broadcasting.
14368+
* `video.source.recorded` This event occurs when a live stream is recorded and submitted for encoding.
14369+
* `video.caption.generated` This event occurs when an automatic caption has been generated.
14370+
* `video.summary.generated` This event occurs when an automatic summary has been generated.
1436914371
operationId: POST-webhooks
1437014372
requestBody:
1437114373
required: true
@@ -15785,6 +15787,7 @@ components:
1578515787
example: '["video.encoding.quality.completed"]'
1578615788
items:
1578715789
type: string
15790+
enum: ['live-stream.broadcast.started', 'live-stream.broadcast.ended', 'video.source.recorded', 'video.encoding.quality.completed', 'video.caption.generated', 'video.summary.generated']
1578815791
url:
1578915792
type: string
1579015793
description: The URL where the API sends the webhook.
@@ -16885,15 +16888,12 @@ components:
1688516888
events:
1688616889
type: array
1688716890
description: |-
16888-
A list of the webhooks that you are subscribing to. There are Currently four webhook options:
16889-
* ```video.encoding.quality.completed``` Occurs when a new video is uploaded into your account, it will be encoded into several different HLS and mp4 qualities. When each version is encoded, your webhook will get a notification. It will look like ```{ \"type\": \"video.encoding.quality.completed\", \"emittedAt\": \"2021-01-29T16:46:25.217+01:00\", \"videoId\": \"viXXXXXXXX\", \"encoding\": \"hls\", \"quality\": \"720p\"} ```. This request says that the 720p HLS encoding was completed.
16890-
* ```live-stream.broadcast.started``` When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires.
16891-
* ```live-stream.broadcast.ended``` This event fires when a live stream has finished broadcasting.
16892-
* ```video.source.recorded``` Occurs when a live stream is recorded and submitted for encoding.
16891+
An array of webhook events that you want to subscribe to.
1689316892
example:
1689416893
- video.encoding.quality.completed
1689516894
items:
1689616895
type: string
16896+
enum: ['live-stream.broadcast.started', 'live-stream.broadcast.ended', 'video.source.recorded', 'video.encoding.quality.completed', 'video.caption.generated', 'video.summary.generated']
1689716897
url:
1689816898
type: string
1689916899
description: The the url to which HTTP notifications are sent. It could be any http or https URL.
@@ -17458,6 +17458,110 @@ x-webhooks:
1745817458
type: string
1745917459
enum: [240p, 360p, 480p, 720p, 1080p]
1746017460
example: 1080p
17461+
responses:
17462+
'202':
17463+
summary: Accepted
17464+
description: Your webhook server may return this response to api.video to signal that the webhook is accepted.
17465+
video.caption.generated:
17466+
post:
17467+
tags:
17468+
- Webhooks
17469+
summary: Video caption generated
17470+
description: This webhook triggers when the API finishes generating a caption for a video.
17471+
operationId: POST-webhooks
17472+
parameters:
17473+
- in: header
17474+
name: X-Api-Video-WebhookID
17475+
schema:
17476+
type: string
17477+
description: The unique ID of your webhook.
17478+
required: true
17479+
- in: header
17480+
name: X-Api-Video-Signature
17481+
schema:
17482+
type: string
17483+
description: The webhook's body encrypted using the webhook's signature secret, in HMAC SHA256. Use this hash to verify that api.video is the origin of this webhook notification.
17484+
required: true
17485+
requestBody:
17486+
content:
17487+
application/json:
17488+
schema:
17489+
type: object
17490+
properties:
17491+
type:
17492+
type: string
17493+
description: The name of the webhook event that occurred.
17494+
example: video.caption.generated
17495+
emittedAt:
17496+
description: Returns the date-time when the webhook event occurred.
17497+
type: string
17498+
format: date-time
17499+
example: '2024-08-151T10:18:47+00:00'
17500+
videoId:
17501+
description: The ID of the video where the caption was generated.
17502+
type: string
17503+
example: vi4blUQJFrYWbaG44NCh1234
17504+
captionId:
17505+
description: The ID of the caption that was generated.
17506+
type: string
17507+
example: caption_1CHAfLFHT5B5EV4vzT1234
17508+
generationMode:
17509+
description: Returns the method used to generate the caption. `transcript` means that the caption was generated based on the transcription of the video. Learn more about transcripts [here](https://docs.api.video/vod/generate-transcripts).
17510+
type: string
17511+
enum: [transcript]
17512+
example: transcript
17513+
language:
17514+
description: Returns the language of the captions in [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
17515+
example: en
17516+
type: string
17517+
enum: [ar, ca, cs, da, de, el, en, es, fa, fi, fr, he, hi, hr, hu, it, ja, ko, ml, nl, nn, no, pl, pt, ru, sk, sl, te, tr, uk, ur, vi, zh]
17518+
responses:
17519+
'202':
17520+
summary: Accepted
17521+
description: Your webhook server may return this response to api.video to signal that the webhook is accepted.
17522+
video.summary.generated:
17523+
post:
17524+
tags:
17525+
- Webhooks
17526+
summary: Video summary generated
17527+
description: This webhook triggers when the API finishes generating a summary for a video.
17528+
operationId: POST-webhooks
17529+
parameters:
17530+
- in: header
17531+
name: X-Api-Video-WebhookID
17532+
schema:
17533+
type: string
17534+
description: The unique ID of your webhook.
17535+
required: true
17536+
- in: header
17537+
name: X-Api-Video-Signature
17538+
schema:
17539+
type: string
17540+
description: The webhook's body encrypted using the webhook's signature secret, in HMAC SHA256. Use this hash to verify that api.video is the origin of this webhook notification.
17541+
required: true
17542+
requestBody:
17543+
content:
17544+
application/json:
17545+
schema:
17546+
type: object
17547+
properties:
17548+
type:
17549+
type: string
17550+
description: The name of the webhook event that occurred.
17551+
example: video.caption.generated
17552+
emittedAt:
17553+
description: Returns the date-time when the webhook event occurred.
17554+
type: string
17555+
format: date-time
17556+
example: '2024-08-151T10:18:47+00:00'
17557+
videoId:
17558+
description: The ID of the video where the summary was generated.
17559+
type: string
17560+
example: vi4blUQJFrYWbaG44NCh1234
17561+
summaryId:
17562+
description: The ID of the summary that was generated.
17563+
type: string
17564+
example: summary_1CGyYoB9XCgBk4iQna8ocT
1746117565
responses:
1746217566
'202':
1746317567
summary: Accepted

0 commit comments

Comments
 (0)