Skip to main content
POST
/
videos
/
{VIDEO_ID}
/
hotspots
Create hotspot
curl --request POST \
  --url https://api.vidbeo.com/v2/videos/{VIDEO_ID}/hotspots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "show_at": "<string>",
  "hide_at": "<string>",
  "x": 123,
  "y": 123,
  "action": "link",
  "link": "<string>",
  "target": "_blank",
  "opacity": "invisible"
}
'
{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "name": "Example",
    "show_at": "00:00:05",
    "hide_at": "00:00:05",
    "x": 25,
    "y": 25,
    "action": "link",
    "link": "https://example.com",
    "target": "_parent",
    "opacity": "translucent"
  },
  "links": {},
  "errors": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
VIDEO_ID
string
required

ID of the video

Example:

"abcde12345abcde12345a"

Body

application/json
​
name
string

A short label for the hotspot

Maximum string length: 100
​
show_at
string

The time-code the hotspot should appear at, as HH:MM:SS

Maximum string length: 8
​
hide_at
string

The time-code the hotspot should hide at, as HH:MM:SS

Maximum string length: 8
​
x
number

Where should the hotspot be horizontally positioned (we suggest 25-75)?

​
y
number

Where should the hotspot be vertically positioned (we suggest 25-75)?

​
action
enum<string>

What should happen when the hotspot is clicked?

Available options:
link
​
link
string<uri>

The URL viewers will be taken to if they click the hotspot

Maximum string length: 100
​
target
enum<string>

Where should the link open?

Available options:
_blank,
_parent
​
opacity
enum<string>

How should the hotspot appear?

Available options:
invisible,
translucent,
opaque

Response

Hotspot

​
success
boolean
required
Example:

true

​
result
object
required
​
links
object
required
Example:
{}
​
errors
object[]
required
Example:
[]