Update Endpoint
curl --request PUT \
--url https://client-backend.oktivo.com/webhooks/endpoints/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"eventTypes": [
{}
],
"description": "<string>",
"agentIds": [
{}
],
"isActive": true,
"deliveryProfile": "<string>"
}
'import requests
url = "https://client-backend.oktivo.com/webhooks/endpoints/{webhookId}"
payload = {
"url": "<string>",
"eventTypes": [{}],
"description": "<string>",
"agentIds": [{}],
"isActive": True,
"deliveryProfile": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
eventTypes: [{}],
description: '<string>',
agentIds: [{}],
isActive: true,
deliveryProfile: '<string>'
})
};
fetch('https://client-backend.oktivo.com/webhooks/endpoints/{webhookId}', 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://client-backend.oktivo.com/webhooks/endpoints/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'eventTypes' => [
[
]
],
'description' => '<string>',
'agentIds' => [
[
]
],
'isActive' => true,
'deliveryProfile' => '<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://client-backend.oktivo.com/webhooks/endpoints/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"eventTypes\": [\n {}\n ],\n \"description\": \"<string>\",\n \"agentIds\": [\n {}\n ],\n \"isActive\": true,\n \"deliveryProfile\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://client-backend.oktivo.com/webhooks/endpoints/{webhookId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"eventTypes\": [\n {}\n ],\n \"description\": \"<string>\",\n \"agentIds\": [\n {}\n ],\n \"isActive\": true,\n \"deliveryProfile\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-backend.oktivo.com/webhooks/endpoints/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"eventTypes\": [\n {}\n ],\n \"description\": \"<string>\",\n \"agentIds\": [\n {}\n ],\n \"isActive\": true,\n \"deliveryProfile\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"endpoint": {
"webhookId": "wh_abc123def456",
"url": "https://new-url.company.com/webhooks/oktivo",
"eventTypes": ["call.ended", "call.analysis_ready", "call.completed"],
"description": "Updated integration",
"agentIds": ["agent_new_qualifier"],
"isActive": true,
"payloadMode": "standard",
"deliveryProfile": "standard"
}
}
{
"error": "Webhook endpoint not found"
}
Webhooks
Update Endpoint
Update a webhook endpoint’s URL, events, active status, agent filter or delivery format.
PUT
/
webhooks
/
endpoints
/
{webhookId}
Update Endpoint
curl --request PUT \
--url https://client-backend.oktivo.com/webhooks/endpoints/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"eventTypes": [
{}
],
"description": "<string>",
"agentIds": [
{}
],
"isActive": true,
"deliveryProfile": "<string>"
}
'import requests
url = "https://client-backend.oktivo.com/webhooks/endpoints/{webhookId}"
payload = {
"url": "<string>",
"eventTypes": [{}],
"description": "<string>",
"agentIds": [{}],
"isActive": True,
"deliveryProfile": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
eventTypes: [{}],
description: '<string>',
agentIds: [{}],
isActive: true,
deliveryProfile: '<string>'
})
};
fetch('https://client-backend.oktivo.com/webhooks/endpoints/{webhookId}', 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://client-backend.oktivo.com/webhooks/endpoints/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'eventTypes' => [
[
]
],
'description' => '<string>',
'agentIds' => [
[
]
],
'isActive' => true,
'deliveryProfile' => '<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://client-backend.oktivo.com/webhooks/endpoints/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"eventTypes\": [\n {}\n ],\n \"description\": \"<string>\",\n \"agentIds\": [\n {}\n ],\n \"isActive\": true,\n \"deliveryProfile\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://client-backend.oktivo.com/webhooks/endpoints/{webhookId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"eventTypes\": [\n {}\n ],\n \"description\": \"<string>\",\n \"agentIds\": [\n {}\n ],\n \"isActive\": true,\n \"deliveryProfile\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-backend.oktivo.com/webhooks/endpoints/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"eventTypes\": [\n {}\n ],\n \"description\": \"<string>\",\n \"agentIds\": [\n {}\n ],\n \"isActive\": true,\n \"deliveryProfile\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"endpoint": {
"webhookId": "wh_abc123def456",
"url": "https://new-url.company.com/webhooks/oktivo",
"eventTypes": ["call.ended", "call.analysis_ready", "call.completed"],
"description": "Updated integration",
"agentIds": ["agent_new_qualifier"],
"isActive": true,
"payloadMode": "standard",
"deliveryProfile": "standard"
}
}
{
"error": "Webhook endpoint not found"
}
Path Parameters
Request Body
All fields are optional. Include only the fields you want to change.Updated list of event types to subscribe to. At least one is required if you send the field. See Create Endpoint for the valid values.
Update the agent filter (up to 50 agents). Send an empty array to receive events from all agents. The older single
agentId is still accepted, and agentId: null clears the filter.Set to
false to pause the endpoint (stops receiving events) or true to re-enable it. Re-enabling also resets the failure counter, so an endpoint that was switched off automatically starts fresh.Delivery format:
standard or panzo. Only valid for endpoints in standard payload mode (custom mode returns 400). Applies to events enqueued after you save the change. See Webhooks.Response
{
"success": true,
"endpoint": {
"webhookId": "wh_abc123def456",
"url": "https://new-url.company.com/webhooks/oktivo",
"eventTypes": ["call.ended", "call.analysis_ready", "call.completed"],
"description": "Updated integration",
"agentIds": ["agent_new_qualifier"],
"isActive": true,
"payloadMode": "standard",
"deliveryProfile": "standard"
}
}
{
"error": "Webhook endpoint not found"
}
This endpoint requires JWT authentication.