Create new Webhook
curl --request POST \
--url https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"name": "Production Webhook",
"url": "https://example.com/webhook",
"module": "global | dynamics",
"description": "Webhook for production environment",
"extraHeaders": [
"Authorization",
"Content-Type"
],
"identifiers": [
"sdfgh2345werty345678dfghj"
],
"events": [
"video_watched",
"video_played",
"video_cta_clicked",
"video_viewed",
"video_liked",
"video_request_received",
"video_generated_dv",
"video_mp4_ready",
"video_generated_error"
]
}
'import requests
url = "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks"
payload = {
"name": "Production Webhook",
"url": "https://example.com/webhook",
"module": "global | dynamics",
"description": "Webhook for production environment",
"extraHeaders": ["Authorization", "Content-Type"],
"identifiers": ["sdfgh2345werty345678dfghj"],
"events": ["video_watched", "video_played", "video_cta_clicked", "video_viewed", "video_liked", "video_request_received", "video_generated_dv", "video_mp4_ready", "video_generated_error"]
}
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Production Webhook',
url: 'https://example.com/webhook',
module: 'global | dynamics',
description: 'Webhook for production environment',
extraHeaders: ['Authorization', 'Content-Type'],
identifiers: ['sdfgh2345werty345678dfghj'],
events: [
'video_watched',
'video_played',
'video_cta_clicked',
'video_viewed',
'video_liked',
'video_request_received',
'video_generated_dv',
'video_mp4_ready',
'video_generated_error'
]
})
};
fetch('https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks', 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-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks",
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([
'name' => 'Production Webhook',
'url' => 'https://example.com/webhook',
'module' => 'global | dynamics',
'description' => 'Webhook for production environment',
'extraHeaders' => [
'Authorization',
'Content-Type'
],
'identifiers' => [
'sdfgh2345werty345678dfghj'
],
'events' => [
'video_watched',
'video_played',
'video_cta_clicked',
'video_viewed',
'video_liked',
'video_request_received',
'video_generated_dv',
'video_mp4_ready',
'video_generated_error'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <api-key>"
],
]);
$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-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks"
payload := strings.NewReader("{\n \"name\": \"Production Webhook\",\n \"url\": \"https://example.com/webhook\",\n \"module\": \"global | dynamics\",\n \"description\": \"Webhook for production environment\",\n \"extraHeaders\": [\n \"Authorization\",\n \"Content-Type\"\n ],\n \"identifiers\": [\n \"sdfgh2345werty345678dfghj\"\n ],\n \"events\": [\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\",\n \"video_request_received\",\n \"video_generated_dv\",\n \"video_mp4_ready\",\n \"video_generated_error\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<api-key>")
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-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production Webhook\",\n \"url\": \"https://example.com/webhook\",\n \"module\": \"global | dynamics\",\n \"description\": \"Webhook for production environment\",\n \"extraHeaders\": [\n \"Authorization\",\n \"Content-Type\"\n ],\n \"identifiers\": [\n \"sdfgh2345werty345678dfghj\"\n ],\n \"events\": [\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\",\n \"video_request_received\",\n \"video_generated_dv\",\n \"video_mp4_ready\",\n \"video_generated_error\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Production Webhook\",\n \"url\": \"https://example.com/webhook\",\n \"module\": \"global | dynamics\",\n \"description\": \"Webhook for production environment\",\n \"extraHeaders\": [\n \"Authorization\",\n \"Content-Type\"\n ],\n \"identifiers\": [\n \"sdfgh2345werty345678dfghj\"\n ],\n \"events\": [\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\",\n \"video_request_received\",\n \"video_generated_dv\",\n \"video_mp4_ready\",\n \"video_generated_error\"\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"statusCode": 400,
"code": "S400-AHVE",
"error": "Bad Request",
"message": "Invalid request payload input"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found or invalid access"
}Webhook
Create new Webhook
Create new Webhook
POST
/
v1
/
workspaces
/
{workspaceId}
/
webhooks
Create new Webhook
curl --request POST \
--url https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"name": "Production Webhook",
"url": "https://example.com/webhook",
"module": "global | dynamics",
"description": "Webhook for production environment",
"extraHeaders": [
"Authorization",
"Content-Type"
],
"identifiers": [
"sdfgh2345werty345678dfghj"
],
"events": [
"video_watched",
"video_played",
"video_cta_clicked",
"video_viewed",
"video_liked",
"video_request_received",
"video_generated_dv",
"video_mp4_ready",
"video_generated_error"
]
}
'import requests
url = "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks"
payload = {
"name": "Production Webhook",
"url": "https://example.com/webhook",
"module": "global | dynamics",
"description": "Webhook for production environment",
"extraHeaders": ["Authorization", "Content-Type"],
"identifiers": ["sdfgh2345werty345678dfghj"],
"events": ["video_watched", "video_played", "video_cta_clicked", "video_viewed", "video_liked", "video_request_received", "video_generated_dv", "video_mp4_ready", "video_generated_error"]
}
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Production Webhook',
url: 'https://example.com/webhook',
module: 'global | dynamics',
description: 'Webhook for production environment',
extraHeaders: ['Authorization', 'Content-Type'],
identifiers: ['sdfgh2345werty345678dfghj'],
events: [
'video_watched',
'video_played',
'video_cta_clicked',
'video_viewed',
'video_liked',
'video_request_received',
'video_generated_dv',
'video_mp4_ready',
'video_generated_error'
]
})
};
fetch('https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks', 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-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks",
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([
'name' => 'Production Webhook',
'url' => 'https://example.com/webhook',
'module' => 'global | dynamics',
'description' => 'Webhook for production environment',
'extraHeaders' => [
'Authorization',
'Content-Type'
],
'identifiers' => [
'sdfgh2345werty345678dfghj'
],
'events' => [
'video_watched',
'video_played',
'video_cta_clicked',
'video_viewed',
'video_liked',
'video_request_received',
'video_generated_dv',
'video_mp4_ready',
'video_generated_error'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <api-key>"
],
]);
$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-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks"
payload := strings.NewReader("{\n \"name\": \"Production Webhook\",\n \"url\": \"https://example.com/webhook\",\n \"module\": \"global | dynamics\",\n \"description\": \"Webhook for production environment\",\n \"extraHeaders\": [\n \"Authorization\",\n \"Content-Type\"\n ],\n \"identifiers\": [\n \"sdfgh2345werty345678dfghj\"\n ],\n \"events\": [\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\",\n \"video_request_received\",\n \"video_generated_dv\",\n \"video_mp4_ready\",\n \"video_generated_error\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<api-key>")
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-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production Webhook\",\n \"url\": \"https://example.com/webhook\",\n \"module\": \"global | dynamics\",\n \"description\": \"Webhook for production environment\",\n \"extraHeaders\": [\n \"Authorization\",\n \"Content-Type\"\n ],\n \"identifiers\": [\n \"sdfgh2345werty345678dfghj\"\n ],\n \"events\": [\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\",\n \"video_request_received\",\n \"video_generated_dv\",\n \"video_mp4_ready\",\n \"video_generated_error\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Production Webhook\",\n \"url\": \"https://example.com/webhook\",\n \"module\": \"global | dynamics\",\n \"description\": \"Webhook for production environment\",\n \"extraHeaders\": [\n \"Authorization\",\n \"Content-Type\"\n ],\n \"identifiers\": [\n \"sdfgh2345werty345678dfghj\"\n ],\n \"events\": [\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\",\n \"video_request_received\",\n \"video_generated_dv\",\n \"video_mp4_ready\",\n \"video_generated_error\"\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"statusCode": 400,
"code": "S400-AHVE",
"error": "Bad Request",
"message": "Invalid request payload input"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found or invalid access"
}Path Parameters
Body
application/json
Example:
"Production Webhook"
Example:
"https://example.com/webhook"
Available options:
global, dynamics Example:
"global | dynamics"
Example:
"Webhook for production environment"
Example:
["Authorization", "Content-Type"]
Available options:
video_watched, video_played, video_cta_clicked, video_viewed, video_liked, video_request_received, video_generated_dv, video_mp4_ready, video_generated_error Example:
[
"video_watched",
"video_played",
"video_cta_clicked",
"video_viewed",
"video_liked",
"video_request_received",
"video_generated_dv",
"video_mp4_ready",
"video_generated_error"
]
Show child attributes
Show child attributes
Response
Successful
The response is of type object.
Was this page helpful?
⌘I