Webhook

VEED

Search…

Introduction to VEED API

Getting Started

API Reference

Objects

Webhook

Instead of polling the API each time you start a render or create an asset, you can set up a webhook.

Setting it up
If you go to the dashboard, under the settings panel, you can input a public url. We will send all webhook events for your account to this url. It must be an https url.
Event types
Let's look at two different types of event - render and assets .
Render
These events enable you to keep track of all your render requests and process their results.
Queued
If your render pool is full, we will queue up the task and provide you with a position field. This tells you the position in the queue, of your new request:
1
  {
2
    "type": "RENDER_QUEUED",
3
    "payload": {
4
      "id": "b477e483-592a-4bc6-a22b-563ef7f48e25",
5
      "position": 2,
6
    }
7
  }
Copied!
Progress
Once your request starts processing, we will periodically send you progress events until the request either succeeds or in rare cases fails.
1
  {
2
    "type": "RENDER_PROGRESS",
3
    "payload": {
4
      "id": "b477e483-592a-4bc6-a22b-563ef7f48e25",
5
      "progress": 56,
6
    }
7
  }
Copied!
Success
Once the render is finished, a success event will be sent, with a url attached, from which you can download the video file:
1
  {
2
    "type": "RENDER_SUCCESS",
3
    "payload": {
4
      "id": "b477e483-592a-4bc6-a22b-563ef7f48e25",
5
      "progress": 100,
6
      "url": "https://cdn.veed.dev/R1vqZ0KfPp5y2z7ddiTyt.mp4"
7
    }
8
  }
Copied!
Failure
If something goes wrong during the render, a failure event will be sent alongside a message field, to help you debug the problem. If you have any problems at all, please don't hesitate to contact us!
1
  {
2
    "type": "RENDER_FAILURE",
3
    "payload": {
4
      "id": "b477e483-592a-4bc6-a22b-563ef7f48e25",
5
      "message": "Video file corrupted."
6
    }
7
  }
Copied!
​
Assets
An asset emits different events that help you keep track of its state:
Uploaded
Once your file is uploaded, we will send an uploaded event, with the url where your asset is stored:
1
  {
2
    "type": "ASSET_UPLOADED",
3
    "payload": {
4
        "id": "28a510a8-6690-4cdc-b319-e0e02ebf1a2e",
5
        "type": "video",
6
        "url": "https://cdn.veed.dev/380rreVE_9uhiksitOGIW.mp4"
7
    }
8
  }
Copied!
Transcribed
If you choose to transcribe your asset, we will send a transcribed event when transcription has finished:
1
  {
2
    "type": "ASSET_UPLOADED",
3
    "payload": {
4
        "id": "28a510a8-6690-4cdc-b319-e0e02ebf1a2e",
5
        "type": "video",
6
        "url": "https://cdn.veed.dev/380rreVE_9uhiksitOGIW.mp4",
7
        "trancription": [
8
          { "value": "Hey, how are you?", "from": "1.54", "to": "3.34" },
9
          { "value": "This is an example of transcription feature", "from": "3.73", "to": "5.26"},
10
        ]
11
    }
12
  }
Copied!