You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A list of the webhooks that you are subscribing to. There are Currently four webhook options:
17894
-
* ```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.
17895
-
* ```live-stream.broadcast.started``` When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires.
17896
-
* ```live-stream.broadcast.ended``` This event fires when a live stream has finished broadcasting.
17897
-
* ```video.source.recorded``` Occurs when a live stream is recorded and submitted for encoding.
17902
+
description: An array of webhook events that you want to subscribe to.
17898
17903
example:
17899
17904
- video.encoding.quality.completed
17900
17905
items:
17906
+
enum:
17907
+
- live-stream.broadcast.started
17908
+
- live-stream.broadcast.ended
17909
+
- video.source.recorded
17910
+
- video.encoding.quality.completed
17911
+
- video.caption.generated
17912
+
- video.summary.generated
17901
17913
type: string
17902
17914
type: array
17903
17915
url:
@@ -18897,4 +18909,153 @@ x-webhooks:
18897
18909
summary: Accepted
18898
18910
description: Your webhook server may return this response to api.video to
18899
18911
signal that the webhook is accepted.
18912
+
video.caption.generated:
18913
+
post:
18914
+
tags:
18915
+
- Webhooks
18916
+
summary: Video caption generated
18917
+
description: This webhook triggers when the API finishes generating a caption
18918
+
for a video.
18919
+
operationId: POST-webhooks
18920
+
parameters:
18921
+
- in: header
18922
+
name: X-Api-Video-WebhookID
18923
+
schema:
18924
+
type: string
18925
+
description: The unique ID of your webhook.
18926
+
required: true
18927
+
- in: header
18928
+
name: X-Api-Video-Signature
18929
+
schema:
18930
+
type: string
18931
+
description: The webhook's body encrypted using the webhook's signature secret,
18932
+
in HMAC SHA256. Use this hash to verify that api.video is the origin of
18933
+
this webhook notification.
18934
+
required: true
18935
+
requestBody:
18936
+
content:
18937
+
application/json:
18938
+
schema:
18939
+
type: object
18940
+
properties:
18941
+
type:
18942
+
type: string
18943
+
description: The name of the webhook event that occurred.
18944
+
example: video.caption.generated
18945
+
emittedAt:
18946
+
description: Returns the date-time when the webhook event occurred.
18947
+
type: string
18948
+
format: date-time
18949
+
example: 2024-08-151T10:18:47+00:00
18950
+
videoId:
18951
+
description: The ID of the video for which the caption was generated.
18952
+
type: string
18953
+
example: vi4blUQJFrYWbaG44NCh1234
18954
+
captionId:
18955
+
description: The ID of the caption that was generated.
18956
+
type: string
18957
+
example: caption_1CHAfLFHT5B5EV4vzT1234
18958
+
generationMode:
18959
+
description: Returns the method used to generate the caption. `transcript`
18960
+
means that the caption was generated based on the transcription
18961
+
of the video. Learn more about transcripts [here](https://docs.api.video/vod/generate-transcripts).
18962
+
type: string
18963
+
enum:
18964
+
- transcript
18965
+
example: transcript
18966
+
language:
18967
+
description: Returns the language of the captions in [IETF language
**webhookId** | **String** | A unique identifier of the webhook you subscribed to. | [optional]
10
10
**createdAt** | **OffsetDateTime** | The time and date when you created this webhook subscription, in ATOM UTC format. | [optional]
11
-
**events** | **List<String>** | A list of events that you subscribed to. When these events occur, the API triggers a webhook call to the URL you provided. | [optional]
11
+
**events** | [**List<EventsEnum>**](#List<EventsEnum>) | A list of events that you subscribed to. When these events occur, the API triggers a webhook call to the URL you provided. | [optional]
12
12
**url** | **String** | The URL where the API sends the webhook. | [optional]
13
13
**signatureSecret** | **String** | A secret key for the webhook you subscribed to. You can use it to verify the origin of the webhook call that you receive. | [optional]
Webhooks can push notifications to your server, rather than polling api.video for changes. We currently offer four events: * ```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. * ```live-stream.broadcast.started``` When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires. * ```live-stream.broadcast.ended``` This event fires when a live stream has finished broadcasting. * ```video.source.recorded``` This event occurs when a live stream is recorded and submitted for encoding.
21
+
Webhooks can push notifications to your server, rather than polling api.video for changes. We currently offer four events: * `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. * `live-stream.broadcast.started` When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires. * `live-stream.broadcast.ended` This event fires when a live stream has finished broadcasting. * `video.source.recorded` This event occurs when a live stream is recorded and submitted for encoding. * `video.caption.generated` This event occurs when an automatic caption has been generated. * `video.summary.generated` This event occurs when an automatic summary has been generated.
webhooksCreationPayload.setEvents(Arrays.asList("video.encoding.quality.completed")); // A list of the webhooks that you are subscribing to. There are Currently four webhook options:
42
-
*```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.
43
-
*```live-stream.broadcast.started``` When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires.
44
-
*```live-stream.broadcast.ended``` This event fires when a live stream has finished broadcasting.
45
-
*```video.source.recorded``` Occurs when a live stream is recorded and submitted for encoding.
41
+
webhooksCreationPayload.setEvents(Arrays.asList("video.encoding.quality.completed")); // An array of webhook events that you want to subscribe to.
46
42
webhooksCreationPayload.setUrl("https://example.com/webhooks"); // The the url to which HTTP notifications are sent. It could be any http or https URL.
**events** | **List<String>** | A list of the webhooks that you are subscribing to. There are Currently four webhook options: * ```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. * ```live-stream.broadcast.started``` When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires. * ```live-stream.broadcast.ended``` This event fires when a live stream has finished broadcasting. * ```video.source.recorded``` Occurs when a live stream is recorded and submitted for encoding. |
9
+
**events** | [**List<EventsEnum>**](#List<EventsEnum>) | An array of webhook events that you want to subscribe to. |
10
10
**url** | **String** | The the url to which HTTP notifications are sent. It could be any http or https URL. |
0 commit comments