Events
Create or update a project event definition
Creates a definition for an event type. If a definition with the same
name already exists, Kapso updates its editable metadata and returns it.
Use /events when you want to emit an actual event occurrence.
POST
/
event-definitions
Create or update a project event definition
curl --request POST \
--url https://api.kapso.ai/platform/v1/event-definitions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "conversation.csat_scored",
"description": "Customer satisfaction score for a conversation",
"property_schema": {
"score": {
"type": "number"
},
"reason": {
"type": "string"
}
}
}
'import requests
url = "https://api.kapso.ai/platform/v1/event-definitions"
payload = {
"name": "conversation.csat_scored",
"description": "Customer satisfaction score for a conversation",
"property_schema": {
"score": { "type": "number" },
"reason": { "type": "string" }
}
}
headers = {
"X-API-Key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'conversation.csat_scored',
description: 'Customer satisfaction score for a conversation',
property_schema: {score: {type: 'number'}, reason: {type: 'string'}}
})
};
fetch('https://api.kapso.ai/platform/v1/event-definitions', 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.kapso.ai/platform/v1/event-definitions",
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' => 'conversation.csat_scored',
'description' => 'Customer satisfaction score for a conversation',
'property_schema' => [
'score' => [
'type' => 'number'
],
'reason' => [
'type' => 'string'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.kapso.ai/platform/v1/event-definitions"
payload := strings.NewReader("{\n \"name\": \"conversation.csat_scored\",\n \"description\": \"Customer satisfaction score for a conversation\",\n \"property_schema\": {\n \"score\": {\n \"type\": \"number\"\n },\n \"reason\": {\n \"type\": \"string\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.kapso.ai/platform/v1/event-definitions")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"conversation.csat_scored\",\n \"description\": \"Customer satisfaction score for a conversation\",\n \"property_schema\": {\n \"score\": {\n \"type\": \"number\"\n },\n \"reason\": {\n \"type\": \"string\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/event-definitions")
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["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"conversation.csat_scored\",\n \"description\": \"Customer satisfaction score for a conversation\",\n \"property_schema\": {\n \"score\": {\n \"type\": \"number\"\n },\n \"reason\": {\n \"type\": \"string\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "conversation.csat_scored",
"property_schema": {
"score": {
"type": "number"
},
"reason": {
"type": "string"
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z"
}
}{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "conversation.csat_scored",
"property_schema": {
"score": {
"type": "number"
},
"reason": {
"type": "string"
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Body
application/json
Event name. Lowercase dotted snake_case is recommended for consistency.
Example:
"conversation.csat_scored"
Human-readable description of what this event means
Declared properties for this event. Values are keyed by property name.
Show child attributes
Show child attributes
Example:
{
"score": { "type": "number" },
"reason": { "type": "string" }
}Response
Existing definition updated
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Create or update a project event definition
curl --request POST \
--url https://api.kapso.ai/platform/v1/event-definitions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "conversation.csat_scored",
"description": "Customer satisfaction score for a conversation",
"property_schema": {
"score": {
"type": "number"
},
"reason": {
"type": "string"
}
}
}
'import requests
url = "https://api.kapso.ai/platform/v1/event-definitions"
payload = {
"name": "conversation.csat_scored",
"description": "Customer satisfaction score for a conversation",
"property_schema": {
"score": { "type": "number" },
"reason": { "type": "string" }
}
}
headers = {
"X-API-Key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'conversation.csat_scored',
description: 'Customer satisfaction score for a conversation',
property_schema: {score: {type: 'number'}, reason: {type: 'string'}}
})
};
fetch('https://api.kapso.ai/platform/v1/event-definitions', 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.kapso.ai/platform/v1/event-definitions",
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' => 'conversation.csat_scored',
'description' => 'Customer satisfaction score for a conversation',
'property_schema' => [
'score' => [
'type' => 'number'
],
'reason' => [
'type' => 'string'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.kapso.ai/platform/v1/event-definitions"
payload := strings.NewReader("{\n \"name\": \"conversation.csat_scored\",\n \"description\": \"Customer satisfaction score for a conversation\",\n \"property_schema\": {\n \"score\": {\n \"type\": \"number\"\n },\n \"reason\": {\n \"type\": \"string\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.kapso.ai/platform/v1/event-definitions")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"conversation.csat_scored\",\n \"description\": \"Customer satisfaction score for a conversation\",\n \"property_schema\": {\n \"score\": {\n \"type\": \"number\"\n },\n \"reason\": {\n \"type\": \"string\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/event-definitions")
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["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"conversation.csat_scored\",\n \"description\": \"Customer satisfaction score for a conversation\",\n \"property_schema\": {\n \"score\": {\n \"type\": \"number\"\n },\n \"reason\": {\n \"type\": \"string\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "conversation.csat_scored",
"property_schema": {
"score": {
"type": "number"
},
"reason": {
"type": "string"
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z"
}
}{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "conversation.csat_scored",
"property_schema": {
"score": {
"type": "number"
},
"reason": {
"type": "string"
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}
