Skip to main content
POST
/
api
/
v2
/
buying-trigger
/
generate
Generate Buying Triggers
curl --request POST \
  --url https://app.octavehq.com/api/v2/buying-trigger/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "buyingTriggers": [
    {
      "sources": [
        {
          "type": "TEXT",
          "value": "Lead generation and qualification for enterprise sales"
        }
      ],
      "name": "New CTO hired"
    }
  ],
  "primaryOfferingOId": "o_123456",
  "linkingStrategy": {
    "mode": "ALL"
  },
  "brandVoiceOId": "bv_123456"
}
'
import requests

url = "https://app.octavehq.com/api/v2/buying-trigger/generate"

payload = {
    "buyingTriggers": [
        {
            "sources": [
                {
                    "type": "TEXT",
                    "value": "Lead generation and qualification for enterprise sales"
                }
            ],
            "name": "New CTO hired"
        }
    ],
    "primaryOfferingOId": "o_123456",
    "linkingStrategy": { "mode": "ALL" },
    "brandVoiceOId": "bv_123456"
}
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({
    buyingTriggers: [
      {
        sources: [
          {type: 'TEXT', value: 'Lead generation and qualification for enterprise sales'}
        ],
        name: 'New CTO hired'
      }
    ],
    primaryOfferingOId: 'o_123456',
    linkingStrategy: {mode: 'ALL'},
    brandVoiceOId: 'bv_123456'
  })
};

fetch('https://app.octavehq.com/api/v2/buying-trigger/generate', 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/buying-trigger/generate",
  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([
    'buyingTriggers' => [
        [
                'sources' => [
                                [
                                                                'type' => 'TEXT',
                                                                'value' => 'Lead generation and qualification for enterprise sales'
                                ]
                ],
                'name' => 'New CTO hired'
        ]
    ],
    'primaryOfferingOId' => 'o_123456',
    'linkingStrategy' => [
        'mode' => 'ALL'
    ],
    'brandVoiceOId' => 'bv_123456'
  ]),
  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/buying-trigger/generate"

	payload := strings.NewReader("{\n  \"buyingTriggers\": [\n    {\n      \"sources\": [\n        {\n          \"type\": \"TEXT\",\n          \"value\": \"Lead generation and qualification for enterprise sales\"\n        }\n      ],\n      \"name\": \"New CTO hired\"\n    }\n  ],\n  \"primaryOfferingOId\": \"o_123456\",\n  \"linkingStrategy\": {\n    \"mode\": \"ALL\"\n  },\n  \"brandVoiceOId\": \"bv_123456\"\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/buying-trigger/generate")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"buyingTriggers\": [\n    {\n      \"sources\": [\n        {\n          \"type\": \"TEXT\",\n          \"value\": \"Lead generation and qualification for enterprise sales\"\n        }\n      ],\n      \"name\": \"New CTO hired\"\n    }\n  ],\n  \"primaryOfferingOId\": \"o_123456\",\n  \"linkingStrategy\": {\n    \"mode\": \"ALL\"\n  },\n  \"brandVoiceOId\": \"bv_123456\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/buying-trigger/generate")

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  \"buyingTriggers\": [\n    {\n      \"sources\": [\n        {\n          \"type\": \"TEXT\",\n          \"value\": \"Lead generation and qualification for enterprise sales\"\n        }\n      ],\n      \"name\": \"New CTO hired\"\n    }\n  ],\n  \"primaryOfferingOId\": \"o_123456\",\n  \"linkingStrategy\": {\n    \"mode\": \"ALL\"\n  },\n  \"brandVoiceOId\": \"bv_123456\"\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": "<string>",
      "updatedAt": "<string>",
      "name": "<string>",
      "internalName": "<string>",
      "description": "<string>",
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "active": true,
      "data": {
        "whyThisCreatesUrgency": [
          "<string>"
        ],
        "whoFeelsThisMost": [
          "<string>"
        ],
        "costOfInaction": [
          "<string>"
        ],
        "howWeHelpInThisMoment": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "<string>",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "<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

api_key
string
header
required

Body

application/json

Buying trigger generation input with source materials

buyingTriggers
object[]
required

Array of buying trigger generation requests - each object generates one buying trigger analysis

Minimum array length: 1
primaryOfferingOId
string

Primary Offering to use as context when generating buying triggers. If not provided, the primary company attached to the Workspace will be used.

Example:

"o_123456"

linkingStrategy
object

Strategy for linking generated buying triggers to offerings (products/services)

brandVoiceOId
string

Brand voice oId to apply to generated buying triggers

Example:

"bv_123456"

Response

Buying triggers generated successfully

_metadata
object
required
data
object[]
required