Webhook

Video asset status

​

Gumlet delivers this notification with HTTP POST and a JSON body to the webhook URL you configured. The x-gumlet-token header is the secret token stored on that webhook, or an empty string when none is stored. A response status from 200 through 299 is recorded as success. Any other status, a timeout, or a connection error is recorded as retrying. Gumlet waits up to 25 seconds for the response and follows up to 5 redirects.

Sent when a video asset changes status and the webhook trigger list contains that event, or contains status. Delivery is limited to webhooks whose video workspace list includes the asset workspace. An empty workspace list matches every video workspace in the organization.

Events:

  • video.status.created — asset was created
  • video.status.downloaded — source file was downloaded for processing
  • video.status.stream_ready — a single rendition is available to stream, immediately after upload
  • video.status.optimized — asset was optimized
  • video.status.ready — asset is ready to embed
  • video.status.repackaged — a subtitle or audio stream was added
  • video.status.errored — processing failed. output is omitted and error is included when the asset has one
  • video.status.deleted — asset was deleted. output is omitted

Headers

  • x-gumlet-token
    Type: string
    required

    Secret token configured on the webhook. Compare it with the token you stored when creating the webhook. The value is an empty string when the webhook has no secret token.

Body·

required
application/json

Body posted for video.status.* events.

  • asset_id
    Type: string
    required

    Video asset id.

  • created_at
    Type: integer
    required

    Asset creation time, in milliseconds since the Unix epoch.

  • input
    Type:
    required
    Properties: 11
  • status
    Type: string
    required

    Current asset status. output is omitted when this is deleted or errored.

  • type
    Type: stringenum
    required

    Video status event that triggered this delivery.

    values
    • video.status.created
    • video.status.downloaded
    • video.status.optimized
    • video.status.ready
    • video.status.errored
    • video.status.deleted
    • video.status.repackaged
    • video.status.stream_ready
  • description
    Type: string

    Asset description.

  • error
    Type:

    Present when the asset status is errored and the asset has an error.

    Properties: 2
  • output
    Type:

    Omitted when the asset status is deleted or errored. Playback URLs use https://video.gumlet.io/{workspace_id}/{asset_id}/.

    Properties: 9
  • tag
    Type: array of string

    Tags stored on the asset.

  • title
    Type: string

    Asset title.

  • warning
    Type:

    Included when process_low_resolution_input is enabled and the smaller frame dimension is below the minimum for the output format: 240 pixels for hls, dash, or abr, and 145 pixels for mp4. Transformations such as resize, crop, pad, and overlay are not applied.

    Properties: 2

Responses

  • 2XX

    Acknowledge delivery. Any status from 200 through 299 is treated as success. Any other response is recorded as retrying.

Request Example for postvideoAssetStatus
{
  "input": {
    "source_url": "http://devimages.apple.com/iphone/samples/bipbop/bipbopall.m3u8",
    "transformations": {
      "format": "abr",
      "resolution": [
        "360p",
        "480p",
        "720p",
        "1080p"
      ],
      "thumbnail": [
        "auto"
      ],
      "thumbnail_format": "png",
      "mp4_access": true
    },
    "profile_id": "646df1c9173a4a2fcac180b7",
    "metadata": {
      "headermeta": "metavalue"
    },
    "fps": 30,
    "width": 1920,
    "height": 1080,
    "duration": 60.5,
    "aspect_ratio": "16:9",
    "size": 1048576
  },
  "output": {
    "format": "abr",
    "status_url": "https://api.gumlet.com/video/v1/status/65b168a6e99b77f116c0e488",
    "playback_url": "https://video.gumlet.io/646df1c9173a4a2fcac180b4/65b168a6e99b77f116c0e488/main.m3u8",
    "dash_playback_url": "https://video.gumlet.io/646df1c9173a4a2fcac180b4/65b168a6e99b77f116c0e488/main.mpd",
    "thumbnail_url": [
      "https://video.gumlet.io/646df1c9173a4a2fcac180b4/65b168a6e99b77f116c0e488/thumbnail-1-0.png"
    ],
    "storage_bytes": 2097152,
    "download_url": "https://video.gumlet.io/646df1c9173a4a2fcac180b4/65b168a6e99b77f116c0e488/download.mp4"
  },
  "type": "video.status.ready",
  "status": "ready",
  "asset_id": "65b168a6e99b77f116c0e488",
  "created_at": 1706125479006,
  "tag": [
    "ball"
  ],
  "title": "Example Title",
  "description": "some description"
}
No Body

Acknowledge delivery. Any status from 200 through 299 is treated as success. Any other response is recorded as retrying.