Merge pull request #105 from apivideo/add-new-webhooks

Add new webhooks
apivideo · Nov 13, 2024 · 4907343 · 4907343
2 parents ddffa6e + cf068a7
commit 4907343
Showing 1 changed file with 149 additions and 0 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -1568,4 +1568,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.