Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add new webhooks #131

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Add new webhooks #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
183 changes: 172 additions & 11 deletions api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14706,17 +14706,20 @@ paths:
x-accepts: application/json
post:
description: "Webhooks can push notifications to your server, rather than polling\
\ api.video for changes. We currently offer four events: \n* ```video.encoding.quality.completed```\
\ api.video for changes. We currently offer four events: \n* `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.\n* ```live-stream.broadcast.started```\
} ```. This request says that the 720p HLS encoding was completed.\n* `live-stream.broadcast.started`\
\ When a live stream begins broadcasting, the broadcasting parameter changes\
\ from false to true, and this webhook fires.\n* ```live-stream.broadcast.ended```\
\ This event fires when a live stream has finished broadcasting.\n* ```video.source.recorded```\
\ This event occurs when a live stream is recorded and submitted for encoding."
\ from false to true, and this webhook fires.\n* `live-stream.broadcast.ended`\
\ This event fires when a live stream has finished broadcasting.\n* `video.source.recorded`\
\ This event occurs when a live stream is recorded and submitted for encoding.\n\
* `video.caption.generated` This event occurs when an automatic caption has\
\ been generated.\n* `video.summary.generated` This event occurs when an\
\ automatic summary has been generated."
operationId: POST-webhooks
requestBody:
content:
Expand Down Expand Up @@ -16362,6 +16365,13 @@ components:
occur, the API triggers a webhook call to the URL you provided.
example: '["video.encoding.quality.completed"]'
items:
enum:
- live-stream.broadcast.started
- live-stream.broadcast.ended
- video.source.recorded
- video.encoding.quality.completed
- video.caption.generated
- video.summary.generated
type: string
type: array
url:
Expand Down Expand Up @@ -17889,15 +17899,17 @@ components:
url: http://clientnotificationserver.com/notif?myquery=query
properties:
events:
description: |-
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.
description: An array of webhook events that you want to subscribe to.
example:
- video.encoding.quality.completed
items:
enum:
- live-stream.broadcast.started
- live-stream.broadcast.ended
- video.source.recorded
- video.encoding.quality.completed
- video.caption.generated
- video.summary.generated
type: string
type: array
url:
Expand Down Expand Up @@ -18897,4 +18909,153 @@ x-webhooks:
summary: Accepted
description: Your webhook server may return this response to api.video to
signal that the webhook is accepted.
video.caption.generated:
post:
tags:
- Webhooks
summary: Video caption generated
description: This webhook triggers when the API finishes generating a caption
for a video.
operationId: POST-webhooks
parameters:
- in: header
name: X-Api-Video-WebhookID
schema:
type: string
description: The unique ID of your webhook.
required: true
- in: header
name: X-Api-Video-Signature
schema:
type: string
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.
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: The name of the webhook event that occurred.
example: video.caption.generated
emittedAt:
description: Returns the date-time when the webhook event occurred.
type: string
format: date-time
example: 2024-08-151T10:18:47+00:00
videoId:
description: The ID of the video for which the caption was generated.
type: string
example: vi4blUQJFrYWbaG44NCh1234
captionId:
description: The ID of the caption that was generated.
type: string
example: caption_1CHAfLFHT5B5EV4vzT1234
generationMode:
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).
type: string
enum:
- transcript
example: transcript
language:
description: Returns the language of the captions in [IETF language
tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
example: en
type: string
enum:
- ar
- ca
- cs
- da
- de
- el
- en
- es
- fa
- fi
- fr
- he
- hi
- hr
- hu
- it
- ja
- ko
- ml
- nl
- nn
- false
- pl
- pt
- ru
- sk
- sl
- te
- tr
- uk
- ur
- vi
- zh
responses:
"202":
summary: Accepted
description: Your webhook server may return this response to api.video to
signal that the webhook is accepted.
video.summary.generated:
post:
tags:
- Webhooks
summary: Video summary generated
description: This webhook triggers when the API finishes generating a summary
for a video.
operationId: POST-webhooks
parameters:
- in: header
name: X-Api-Video-WebhookID
schema:
type: string
description: The unique ID of your webhook.
required: true
- in: header
name: X-Api-Video-Signature
schema:
type: string
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.
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: The name of the webhook event that occurred.
example: video.caption.generated
emittedAt:
description: Returns the date-time when the webhook event occurred.
type: string
format: date-time
example: 2024-08-151T10:18:47+00:00
videoId:
description: The ID of the video for which the summary was generated.
type: string
example: vi4blUQJFrYWbaG44NCh1234
summaryId:
description: The ID of the summary that was generated.
type: string
example: summary_1CGyYoB9XCgBk4iQna8ocT
responses:
"202":
summary: Accepted
description: Your webhook server may return this response to api.video to
signal that the webhook is accepted.

15 changes: 14 additions & 1 deletion docs/Webhook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,24 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**webhookId** | **String** | A unique identifier of the webhook you subscribed to. | [optional]
**createdAt** | **OffsetDateTime** | The time and date when you created this webhook subscription, in ATOM UTC format. | [optional]
**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]
**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]
**url** | **String** | The URL where the API sends the webhook. | [optional]
**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]



## Enum: List<EventsEnum>

Name | Value
---- | -----
LIVE_STREAM_BROADCAST_STARTED | "live-stream.broadcast.started"
LIVE_STREAM_BROADCAST_ENDED | "live-stream.broadcast.ended"
VIDEO_SOURCE_RECORDED | "video.source.recorded"
VIDEO_ENCODING_QUALITY_COMPLETED | "video.encoding.quality.completed"
VIDEO_CAPTION_GENERATED | "video.caption.generated"
VIDEO_SUMMARY_GENERATED | "video.summary.generated"


## Implemented Interfaces

* Serializable
Expand Down
8 changes: 2 additions & 6 deletions docs/WebhooksApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Method | HTTP request | Description

Create Webhook

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.
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.

### Example
```java
Expand All @@ -38,11 +38,7 @@ public class Example {
WebhooksApi apiInstance = client.webhooks();

WebhooksCreationPayload webhooksCreationPayload = new WebhooksCreationPayload(); //
webhooksCreationPayload.setEvents(Arrays.asList("video.encoding.quality.completed")); // 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.
webhooksCreationPayload.setEvents(Arrays.asList("video.encoding.quality.completed")); // An array of webhook events that you want to subscribe to.
webhooksCreationPayload.setUrl("https://example.com/webhooks"); // The the url to which HTTP notifications are sent. It could be any http or https URL.


Expand Down
15 changes: 14 additions & 1 deletion docs/WebhooksCreationPayload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,23 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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. |
**events** | [**List<EventsEnum>**](#List<EventsEnum>) | An array of webhook events that you want to subscribe to. |
**url** | **String** | The the url to which HTTP notifications are sent. It could be any http or https URL. |



## Enum: List<EventsEnum>

Name | Value
---- | -----
LIVE_STREAM_BROADCAST_STARTED | "live-stream.broadcast.started"
LIVE_STREAM_BROADCAST_ENDED | "live-stream.broadcast.ended"
VIDEO_SOURCE_RECORDED | "video.source.recorded"
VIDEO_ENCODING_QUALITY_COMPLETED | "video.encoding.quality.completed"
VIDEO_CAPTION_GENERATED | "video.caption.generated"
VIDEO_SUMMARY_GENERATED | "video.summary.generated"


## Implemented Interfaces

* Serializable
Expand Down
2 changes: 1 addition & 1 deletion src/androidTest/java/video/api/integration/WebhooksTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public WebhooksTest() throws IOException {
public void createWebhook() throws ApiException {
this.webhook = apiClient.webhooks()
.create(new WebhooksCreationPayload()
.events(Collections.singletonList("video.encoding.quality.completed"))
.events(Collections.singletonList(WebhooksCreationPayload.EventsEnum.VIDEO_ENCODING_QUALITY_COMPLETED))
.url("https://webhooks.test-java-api-client.fr"));

assertThat(webhook.getWebhookId()).isNotNull();
Expand Down
Loading
Loading