Update an entity webhook endpoint
curl --request POST \
--url https://app.octavehq.com/api/v2/entity-webhook/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "<string>",
"url": "<string>",
"enabled": true,
"actions": [],
"entityTypes": [],
"oId": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/entity-webhook/update"
payload = {
"name": "<string>",
"url": "<string>",
"enabled": True,
"actions": [],
"entityTypes": [],
"oId": "<string>"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
enabled: true,
actions: [],
entityTypes: [],
oId: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/entity-webhook/update', 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://app.octavehq.com/api/v2/entity-webhook/update",
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' => '<string>',
'url' => '<string>',
'enabled' => true,
'actions' => [
],
'entityTypes' => [
],
'oId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://app.octavehq.com/api/v2/entity-webhook/update"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"actions\": [],\n \"entityTypes\": [],\n \"oId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://app.octavehq.com/api/v2/entity-webhook/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"actions\": [],\n \"entityTypes\": [],\n \"oId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/entity-webhook/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"actions\": [],\n \"entityTypes\": [],\n \"oId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"endpoint": {
"name": "<string>",
"url": "<string>",
"enabled": true,
"actions": [
"created"
],
"entityTypes": [
"product"
],
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"secret": "<string>"
}Entity Webhooks
Update an entity webhook endpoint
Workspace-scoped; requires a workspace owner or Octave admin API key. Requires write API access. Signing secrets are returned only on creation or rotation; store them securely. Replaces the endpoint configuration; all configuration fields are required.
POST
/
api
/
v2
/
entity-webhook
/
update
Update an entity webhook endpoint
curl --request POST \
--url https://app.octavehq.com/api/v2/entity-webhook/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "<string>",
"url": "<string>",
"enabled": true,
"actions": [],
"entityTypes": [],
"oId": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/entity-webhook/update"
payload = {
"name": "<string>",
"url": "<string>",
"enabled": True,
"actions": [],
"entityTypes": [],
"oId": "<string>"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
enabled: true,
actions: [],
entityTypes: [],
oId: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/entity-webhook/update', 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://app.octavehq.com/api/v2/entity-webhook/update",
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' => '<string>',
'url' => '<string>',
'enabled' => true,
'actions' => [
],
'entityTypes' => [
],
'oId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://app.octavehq.com/api/v2/entity-webhook/update"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"actions\": [],\n \"entityTypes\": [],\n \"oId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://app.octavehq.com/api/v2/entity-webhook/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"actions\": [],\n \"entityTypes\": [],\n \"oId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/entity-webhook/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"actions\": [],\n \"entityTypes\": [],\n \"oId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"endpoint": {
"name": "<string>",
"url": "<string>",
"enabled": true,
"actions": [
"created"
],
"entityTypes": [
"product"
],
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"secret": "<string>"
}Authorizations
Body
application/json
Required string length:
1 - 100Maximum string length:
2048Required array length:
1 - 3 elementsAvailable options:
created, updated, deleted Required array length:
1 - 17 elementsAvailable options:
product, service, solution, persona, segment, use_case, reference, proof_point, core_feature, competitor, alternative, buying_trigger, objection, brand_voice, skill, motion, motion_playbook Minimum string length:
1