Create Core Feature
curl --request POST \
--url https://app.octavehq.com/api/v2/core-feature/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "Real-time Deal Risk Alerts",
"primaryOfferingOId": "px_123456",
"internalName": "Deal risk engine",
"description": "Surfaces at-risk deals the moment engagement drops off",
"releaseNotesUrls": [
"https://www.product.com/changelog"
],
"whatItDoes": [
"Flags stalled deals",
"Scores engagement decay"
],
"howItWorks": [
"Monitors activity signals",
"Applies a decay model"
],
"whatItImpacts": [
"Win rate",
"Forecast accuracy"
],
"whyThisExists": [
"Reps miss silent churn signals"
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/core-feature/create"
payload = {
"name": "Real-time Deal Risk Alerts",
"primaryOfferingOId": "px_123456",
"internalName": "Deal risk engine",
"description": "Surfaces at-risk deals the moment engagement drops off",
"releaseNotesUrls": ["https://www.product.com/changelog"],
"whatItDoes": ["Flags stalled deals", "Scores engagement decay"],
"howItWorks": ["Monitors activity signals", "Applies a decay model"],
"whatItImpacts": ["Win rate", "Forecast accuracy"],
"whyThisExists": ["Reps miss silent churn signals"],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
}
}
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: 'Real-time Deal Risk Alerts',
primaryOfferingOId: 'px_123456',
internalName: 'Deal risk engine',
description: 'Surfaces at-risk deals the moment engagement drops off',
releaseNotesUrls: ['https://www.product.com/changelog'],
whatItDoes: ['Flags stalled deals', 'Scores engagement decay'],
howItWorks: ['Monitors activity signals', 'Applies a decay model'],
whatItImpacts: ['Win rate', 'Forecast accuracy'],
whyThisExists: ['Reps miss silent churn signals'],
additionalProperties: {tier: 'Enterprise', region: 'APAC'}
})
};
fetch('https://app.octavehq.com/api/v2/core-feature/create', 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/core-feature/create",
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' => 'Real-time Deal Risk Alerts',
'primaryOfferingOId' => 'px_123456',
'internalName' => 'Deal risk engine',
'description' => 'Surfaces at-risk deals the moment engagement drops off',
'releaseNotesUrls' => [
'https://www.product.com/changelog'
],
'whatItDoes' => [
'Flags stalled deals',
'Scores engagement decay'
],
'howItWorks' => [
'Monitors activity signals',
'Applies a decay model'
],
'whatItImpacts' => [
'Win rate',
'Forecast accuracy'
],
'whyThisExists' => [
'Reps miss silent churn signals'
],
'additionalProperties' => [
'tier' => 'Enterprise',
'region' => 'APAC'
]
]),
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/core-feature/create"
payload := strings.NewReader("{\n \"name\": \"Real-time Deal Risk Alerts\",\n \"primaryOfferingOId\": \"px_123456\",\n \"internalName\": \"Deal risk engine\",\n \"description\": \"Surfaces at-risk deals the moment engagement drops off\",\n \"releaseNotesUrls\": [\n \"https://www.product.com/changelog\"\n ],\n \"whatItDoes\": [\n \"Flags stalled deals\",\n \"Scores engagement decay\"\n ],\n \"howItWorks\": [\n \"Monitors activity signals\",\n \"Applies a decay model\"\n ],\n \"whatItImpacts\": [\n \"Win rate\",\n \"Forecast accuracy\"\n ],\n \"whyThisExists\": [\n \"Reps miss silent churn signals\"\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n }\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/core-feature/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Real-time Deal Risk Alerts\",\n \"primaryOfferingOId\": \"px_123456\",\n \"internalName\": \"Deal risk engine\",\n \"description\": \"Surfaces at-risk deals the moment engagement drops off\",\n \"releaseNotesUrls\": [\n \"https://www.product.com/changelog\"\n ],\n \"whatItDoes\": [\n \"Flags stalled deals\",\n \"Scores engagement decay\"\n ],\n \"howItWorks\": [\n \"Monitors activity signals\",\n \"Applies a decay model\"\n ],\n \"whatItImpacts\": [\n \"Win rate\",\n \"Forecast accuracy\"\n ],\n \"whyThisExists\": [\n \"Reps miss silent churn signals\"\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/core-feature/create")
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\": \"Real-time Deal Risk Alerts\",\n \"primaryOfferingOId\": \"px_123456\",\n \"internalName\": \"Deal risk engine\",\n \"description\": \"Surfaces at-risk deals the moment engagement drops off\",\n \"releaseNotesUrls\": [\n \"https://www.product.com/changelog\"\n ],\n \"whatItDoes\": [\n \"Flags stalled deals\",\n \"Scores engagement decay\"\n ],\n \"howItWorks\": [\n \"Monitors activity signals\",\n \"Applies a decay model\"\n ],\n \"whatItImpacts\": [\n \"Win rate\",\n \"Forecast accuracy\"\n ],\n \"whyThisExists\": [\n \"Reps miss silent churn signals\"\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"internalName": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"releaseNotesUrls": [
"https://www.product.com/changelog"
],
"active": true,
"data": {
"whatItDoes": [
"<string>"
],
"howItWorks": [
"<string>"
],
"whatItImpacts": [
"<string>"
],
"whyThisExists": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
},
"offering": {
"oId": "<string>",
"type": "product",
"name": "<string>"
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Core Feature
Create Core Feature
Create a new core feature under a parent offering
POST
/
api
/
v2
/
core-feature
/
create
Create Core Feature
curl --request POST \
--url https://app.octavehq.com/api/v2/core-feature/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "Real-time Deal Risk Alerts",
"primaryOfferingOId": "px_123456",
"internalName": "Deal risk engine",
"description": "Surfaces at-risk deals the moment engagement drops off",
"releaseNotesUrls": [
"https://www.product.com/changelog"
],
"whatItDoes": [
"Flags stalled deals",
"Scores engagement decay"
],
"howItWorks": [
"Monitors activity signals",
"Applies a decay model"
],
"whatItImpacts": [
"Win rate",
"Forecast accuracy"
],
"whyThisExists": [
"Reps miss silent churn signals"
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/core-feature/create"
payload = {
"name": "Real-time Deal Risk Alerts",
"primaryOfferingOId": "px_123456",
"internalName": "Deal risk engine",
"description": "Surfaces at-risk deals the moment engagement drops off",
"releaseNotesUrls": ["https://www.product.com/changelog"],
"whatItDoes": ["Flags stalled deals", "Scores engagement decay"],
"howItWorks": ["Monitors activity signals", "Applies a decay model"],
"whatItImpacts": ["Win rate", "Forecast accuracy"],
"whyThisExists": ["Reps miss silent churn signals"],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
}
}
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: 'Real-time Deal Risk Alerts',
primaryOfferingOId: 'px_123456',
internalName: 'Deal risk engine',
description: 'Surfaces at-risk deals the moment engagement drops off',
releaseNotesUrls: ['https://www.product.com/changelog'],
whatItDoes: ['Flags stalled deals', 'Scores engagement decay'],
howItWorks: ['Monitors activity signals', 'Applies a decay model'],
whatItImpacts: ['Win rate', 'Forecast accuracy'],
whyThisExists: ['Reps miss silent churn signals'],
additionalProperties: {tier: 'Enterprise', region: 'APAC'}
})
};
fetch('https://app.octavehq.com/api/v2/core-feature/create', 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/core-feature/create",
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' => 'Real-time Deal Risk Alerts',
'primaryOfferingOId' => 'px_123456',
'internalName' => 'Deal risk engine',
'description' => 'Surfaces at-risk deals the moment engagement drops off',
'releaseNotesUrls' => [
'https://www.product.com/changelog'
],
'whatItDoes' => [
'Flags stalled deals',
'Scores engagement decay'
],
'howItWorks' => [
'Monitors activity signals',
'Applies a decay model'
],
'whatItImpacts' => [
'Win rate',
'Forecast accuracy'
],
'whyThisExists' => [
'Reps miss silent churn signals'
],
'additionalProperties' => [
'tier' => 'Enterprise',
'region' => 'APAC'
]
]),
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/core-feature/create"
payload := strings.NewReader("{\n \"name\": \"Real-time Deal Risk Alerts\",\n \"primaryOfferingOId\": \"px_123456\",\n \"internalName\": \"Deal risk engine\",\n \"description\": \"Surfaces at-risk deals the moment engagement drops off\",\n \"releaseNotesUrls\": [\n \"https://www.product.com/changelog\"\n ],\n \"whatItDoes\": [\n \"Flags stalled deals\",\n \"Scores engagement decay\"\n ],\n \"howItWorks\": [\n \"Monitors activity signals\",\n \"Applies a decay model\"\n ],\n \"whatItImpacts\": [\n \"Win rate\",\n \"Forecast accuracy\"\n ],\n \"whyThisExists\": [\n \"Reps miss silent churn signals\"\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n }\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/core-feature/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Real-time Deal Risk Alerts\",\n \"primaryOfferingOId\": \"px_123456\",\n \"internalName\": \"Deal risk engine\",\n \"description\": \"Surfaces at-risk deals the moment engagement drops off\",\n \"releaseNotesUrls\": [\n \"https://www.product.com/changelog\"\n ],\n \"whatItDoes\": [\n \"Flags stalled deals\",\n \"Scores engagement decay\"\n ],\n \"howItWorks\": [\n \"Monitors activity signals\",\n \"Applies a decay model\"\n ],\n \"whatItImpacts\": [\n \"Win rate\",\n \"Forecast accuracy\"\n ],\n \"whyThisExists\": [\n \"Reps miss silent churn signals\"\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/core-feature/create")
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\": \"Real-time Deal Risk Alerts\",\n \"primaryOfferingOId\": \"px_123456\",\n \"internalName\": \"Deal risk engine\",\n \"description\": \"Surfaces at-risk deals the moment engagement drops off\",\n \"releaseNotesUrls\": [\n \"https://www.product.com/changelog\"\n ],\n \"whatItDoes\": [\n \"Flags stalled deals\",\n \"Scores engagement decay\"\n ],\n \"howItWorks\": [\n \"Monitors activity signals\",\n \"Applies a decay model\"\n ],\n \"whatItImpacts\": [\n \"Win rate\",\n \"Forecast accuracy\"\n ],\n \"whyThisExists\": [\n \"Reps miss silent churn signals\"\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"internalName": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"releaseNotesUrls": [
"https://www.product.com/changelog"
],
"active": true,
"data": {
"whatItDoes": [
"<string>"
],
"howItWorks": [
"<string>"
],
"whatItImpacts": [
"<string>"
],
"whyThisExists": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
},
"offering": {
"oId": "<string>",
"type": "product",
"name": "<string>"
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Core Feature creation input
The external name of the core feature (named capability)
Minimum string length:
1Example:
"Real-time Deal Risk Alerts"
Parent Offering (Product, Service, or Solution) this core feature belongs to. A core feature must have exactly one parent offering.
Minimum string length:
1Example:
"px_123456"
The internal name of the core feature
Example:
"Deal risk engine"
A description of the core feature
Example:
"Surfaces at-risk deals the moment engagement drops off"
Watched release-notes pages for this core feature; Octave re-reads each on a schedule and proposes library updates from what shipped. Create-only: the list is set here and afterwards managed in the Octave app under Library → core feature → Release notes, so a partial update can never silently drop the rest.
Example:
["https://www.product.com/changelog"]
Concrete capabilities this feature delivers
Example:
[
"Flags stalled deals",
"Scores engagement decay"
]
How the capability is delivered under the hood
Example:
[
"Monitors activity signals",
"Applies a decay model"
]
Outcomes and metrics this feature moves
Example:
["Win rate", "Forecast accuracy"]
The problem or gap that justifies this feature
Example:
["Reps miss silent churn signals"]
Workspace-defined additional property values for this core feature, keyed by property key.
Show child attributes
Show child attributes
Example:
{ "tier": "Enterprise", "region": "APAC" }