Create a quartile event
curl --request POST \
--url https://api.hubapi.com/media-bridge/v1/events/media-played-percent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"occurredTimestamp": 123,
"playedPercent": 123,
"sessionId": "<string>",
"_hsenc": "<string>",
"contactId": 123,
"contactUtk": "<string>",
"externalId": "<string>",
"mediaBridgeId": 123,
"mediaName": "<string>",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageUrl": "<string>"
}
'import requests
url = "https://api.hubapi.com/media-bridge/v1/events/media-played-percent"
payload = {
"occurredTimestamp": 123,
"playedPercent": 123,
"sessionId": "<string>",
"_hsenc": "<string>",
"contactId": 123,
"contactUtk": "<string>",
"externalId": "<string>",
"mediaBridgeId": 123,
"mediaName": "<string>",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageUrl": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
occurredTimestamp: 123,
playedPercent: 123,
sessionId: '<string>',
_hsenc: '<string>',
contactId: 123,
contactUtk: '<string>',
externalId: '<string>',
mediaBridgeId: 123,
mediaName: '<string>',
mediaUrl: '<string>',
pageId: 123,
pageName: '<string>',
pageUrl: '<string>'
})
};
fetch('https://api.hubapi.com/media-bridge/v1/events/media-played-percent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/media-bridge/v1/events/media-played-percent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'occurredTimestamp' => 123,
'playedPercent' => 123,
'sessionId' => '<string>',
'_hsenc' => '<string>',
'contactId' => 123,
'contactUtk' => '<string>',
'externalId' => '<string>',
'mediaBridgeId' => 123,
'mediaName' => '<string>',
'mediaUrl' => '<string>',
'pageId' => 123,
'pageName' => '<string>',
'pageUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/media-bridge/v1/events/media-played-percent"
payload := strings.NewReader("{\n \"occurredTimestamp\": 123,\n \"playedPercent\": 123,\n \"sessionId\": \"<string>\",\n \"_hsenc\": \"<string>\",\n \"contactId\": 123,\n \"contactUtk\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mediaBridgeId\": 123,\n \"mediaName\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"pageId\": 123,\n \"pageName\": \"<string>\",\n \"pageUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/media-bridge/v1/events/media-played-percent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"occurredTimestamp\": 123,\n \"playedPercent\": 123,\n \"sessionId\": \"<string>\",\n \"_hsenc\": \"<string>\",\n \"contactId\": 123,\n \"contactUtk\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mediaBridgeId\": 123,\n \"mediaName\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"pageId\": 123,\n \"pageName\": \"<string>\",\n \"pageUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/media-bridge/v1/events/media-played-percent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"occurredTimestamp\": 123,\n \"playedPercent\": 123,\n \"sessionId\": \"<string>\",\n \"_hsenc\": \"<string>\",\n \"contactId\": 123,\n \"contactUtk\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mediaBridgeId\": 123,\n \"mediaName\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"pageId\": 123,\n \"pageName\": \"<string>\",\n \"pageUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"contactId": 123,
"mediaBridgeId": 123,
"mediaBridgeObjectCoordinates": "<string>",
"mediaBridgeObjectTypeId": "<string>",
"mediaName": "<string>",
"mediaType": "AUDIO",
"occurredTimestamp": 123,
"playedPercent": 123,
"portalId": 123,
"providerId": 123,
"sessionId": "<string>",
"externalPlayContext": "EMAIL",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageObjectCoordinates": "<string>",
"pageUrl": "<string>"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Events
Create a quartile event
POST
/
media-bridge
/
v1
/
events
/
media-played-percent
Create a quartile event
curl --request POST \
--url https://api.hubapi.com/media-bridge/v1/events/media-played-percent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"occurredTimestamp": 123,
"playedPercent": 123,
"sessionId": "<string>",
"_hsenc": "<string>",
"contactId": 123,
"contactUtk": "<string>",
"externalId": "<string>",
"mediaBridgeId": 123,
"mediaName": "<string>",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageUrl": "<string>"
}
'import requests
url = "https://api.hubapi.com/media-bridge/v1/events/media-played-percent"
payload = {
"occurredTimestamp": 123,
"playedPercent": 123,
"sessionId": "<string>",
"_hsenc": "<string>",
"contactId": 123,
"contactUtk": "<string>",
"externalId": "<string>",
"mediaBridgeId": 123,
"mediaName": "<string>",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageUrl": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
occurredTimestamp: 123,
playedPercent: 123,
sessionId: '<string>',
_hsenc: '<string>',
contactId: 123,
contactUtk: '<string>',
externalId: '<string>',
mediaBridgeId: 123,
mediaName: '<string>',
mediaUrl: '<string>',
pageId: 123,
pageName: '<string>',
pageUrl: '<string>'
})
};
fetch('https://api.hubapi.com/media-bridge/v1/events/media-played-percent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/media-bridge/v1/events/media-played-percent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'occurredTimestamp' => 123,
'playedPercent' => 123,
'sessionId' => '<string>',
'_hsenc' => '<string>',
'contactId' => 123,
'contactUtk' => '<string>',
'externalId' => '<string>',
'mediaBridgeId' => 123,
'mediaName' => '<string>',
'mediaUrl' => '<string>',
'pageId' => 123,
'pageName' => '<string>',
'pageUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/media-bridge/v1/events/media-played-percent"
payload := strings.NewReader("{\n \"occurredTimestamp\": 123,\n \"playedPercent\": 123,\n \"sessionId\": \"<string>\",\n \"_hsenc\": \"<string>\",\n \"contactId\": 123,\n \"contactUtk\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mediaBridgeId\": 123,\n \"mediaName\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"pageId\": 123,\n \"pageName\": \"<string>\",\n \"pageUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/media-bridge/v1/events/media-played-percent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"occurredTimestamp\": 123,\n \"playedPercent\": 123,\n \"sessionId\": \"<string>\",\n \"_hsenc\": \"<string>\",\n \"contactId\": 123,\n \"contactUtk\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mediaBridgeId\": 123,\n \"mediaName\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"pageId\": 123,\n \"pageName\": \"<string>\",\n \"pageUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/media-bridge/v1/events/media-played-percent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"occurredTimestamp\": 123,\n \"playedPercent\": 123,\n \"sessionId\": \"<string>\",\n \"_hsenc\": \"<string>\",\n \"contactId\": 123,\n \"contactUtk\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mediaBridgeId\": 123,\n \"mediaName\": \"<string>\",\n \"mediaUrl\": \"<string>\",\n \"pageId\": 123,\n \"pageName\": \"<string>\",\n \"pageUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"contactId": 123,
"mediaBridgeId": 123,
"mediaBridgeObjectCoordinates": "<string>",
"mediaBridgeObjectTypeId": "<string>",
"mediaName": "<string>",
"mediaType": "AUDIO",
"occurredTimestamp": 123,
"playedPercent": 123,
"portalId": 123,
"providerId": 123,
"sessionId": "<string>",
"externalPlayContext": "EMAIL",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageObjectCoordinates": "<string>",
"pageUrl": "<string>"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Available options:
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO Available options:
EMAIL, EXTERNAL_PAGE Response
successful operation
The ID of the contact in HubSpot’s system that consumed the media. This can be fetched using HubSpot's Get contact by usertoken (utk) API. The API also supports supplying a usertoken, and will handle converting this into a contact ID automatically.
Available options:
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO The ID of the HubSpot account.
Available options:
EMAIL, EXTERNAL_PAGE The content ID of the page that an event happened on, for HubSpot pages. Required if the page is a HubSpot page.
The name or title of the page that an event happened on. Required for non-HubSpot pages.
The URL of the page that an event happened on. Required for non-HubSpot pages.
Last modified on April 13, 2026
Was this page helpful?