Create Webhook Subscription
curl --request POST \
--url https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"name": "Production Task Notifications",
"url": "https://api.yourapp.com/webhooks/xenia",
"events": [
"task.status_changed",
"submission.submitted"
],
"description": "Webhook for production environment",
"rateLimit": 100
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions"
payload = {
"name": "Production Task Notifications",
"url": "https://api.yourapp.com/webhooks/xenia",
"events": ["task.status_changed", "submission.submitted"],
"description": "Webhook for production environment",
"rateLimit": 100
}
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Production Task Notifications',
url: 'https://api.yourapp.com/webhooks/xenia',
events: ['task.status_changed', 'submission.submitted'],
description: 'Webhook for production environment',
rateLimit: 100
})
};
fetch('https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions', 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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions",
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 Task Notifications',
'url' => 'https://api.yourapp.com/webhooks/xenia',
'events' => [
'task.status_changed',
'submission.submitted'
],
'description' => 'Webhook for production environment',
'rateLimit' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions"
payload := strings.NewReader("{\n \"name\": \"Production Task Notifications\",\n \"url\": \"https://api.yourapp.com/webhooks/xenia\",\n \"events\": [\n \"task.status_changed\",\n \"submission.submitted\"\n ],\n \"description\": \"Webhook for production environment\",\n \"rateLimit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production Task Notifications\",\n \"url\": \"https://api.yourapp.com/webhooks/xenia\",\n \"events\": [\n \"task.status_changed\",\n \"submission.submitted\"\n ],\n \"description\": \"Webhook for production environment\",\n \"rateLimit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Production Task Notifications\",\n \"url\": \"https://api.yourapp.com/webhooks/xenia\",\n \"events\": [\n \"task.status_changed\",\n \"submission.submitted\"\n ],\n \"description\": \"Webhook for production environment\",\n \"rateLimit\": 100\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"code": 201,
"data": {
"id": "sub_abc123",
"name": "Production Task Notifications",
"url": "https://api.yourapp.com/webhooks/xenia",
"events": [
"task.status_changed",
"submission.submitted"
],
"secret": "a1b2c3d4e5f6789012345678901234567890123456789012345678901234abcd",
"isActive": true,
"rateLimit": 100,
"createdAt": "2024-12-23T10:00:00Z"
}
}Webhooks
Create Webhook Subscription
POST
/
api
/
v1
/
mgt
/
workspaces
/
{workspaceId}
/
webhook-subscriptions
Create Webhook Subscription
curl --request POST \
--url https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"name": "Production Task Notifications",
"url": "https://api.yourapp.com/webhooks/xenia",
"events": [
"task.status_changed",
"submission.submitted"
],
"description": "Webhook for production environment",
"rateLimit": 100
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions"
payload = {
"name": "Production Task Notifications",
"url": "https://api.yourapp.com/webhooks/xenia",
"events": ["task.status_changed", "submission.submitted"],
"description": "Webhook for production environment",
"rateLimit": 100
}
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Production Task Notifications',
url: 'https://api.yourapp.com/webhooks/xenia',
events: ['task.status_changed', 'submission.submitted'],
description: 'Webhook for production environment',
rateLimit: 100
})
};
fetch('https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions', 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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions",
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 Task Notifications',
'url' => 'https://api.yourapp.com/webhooks/xenia',
'events' => [
'task.status_changed',
'submission.submitted'
],
'description' => 'Webhook for production environment',
'rateLimit' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions"
payload := strings.NewReader("{\n \"name\": \"Production Task Notifications\",\n \"url\": \"https://api.yourapp.com/webhooks/xenia\",\n \"events\": [\n \"task.status_changed\",\n \"submission.submitted\"\n ],\n \"description\": \"Webhook for production environment\",\n \"rateLimit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production Task Notifications\",\n \"url\": \"https://api.yourapp.com/webhooks/xenia\",\n \"events\": [\n \"task.status_changed\",\n \"submission.submitted\"\n ],\n \"description\": \"Webhook for production environment\",\n \"rateLimit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Production Task Notifications\",\n \"url\": \"https://api.yourapp.com/webhooks/xenia\",\n \"events\": [\n \"task.status_changed\",\n \"submission.submitted\"\n ],\n \"description\": \"Webhook for production environment\",\n \"rateLimit\": 100\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"code": 201,
"data": {
"id": "sub_abc123",
"name": "Production Task Notifications",
"url": "https://api.yourapp.com/webhooks/xenia",
"events": [
"task.status_changed",
"submission.submitted"
],
"secret": "a1b2c3d4e5f6789012345678901234567890123456789012345678901234abcd",
"isActive": true,
"rateLimit": 100,
"createdAt": "2024-12-23T10:00:00Z"
}
}Path Parameters
Workspace ID
Body
application/json
Subscription name
Maximum string length:
255HTTPS URL to receive webhooks
Maximum string length:
2048Event types to subscribe to
Required array length:
1 - 50 elementsOptional description
Maximum string length:
2000Requests per minute limit
Required range:
1 <= x <= 1000Custom key-value metadata
⌘I