Replace an agent heartbeat policy
curl --request PUT \
--url https://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sections": {
"goals": true,
"standalone_kpis": true,
"standalone_initiatives": true,
"assigned_issues": true,
"project_context": true,
"signals": true,
"attention": true
},
"signal_categories": {
"task": true,
"initiative": true,
"kpi": false,
"project": true
},
"project_ids": [
"project-uuid"
],
"initiative_ids": [],
"columns": [
{
"project_id": "project-uuid",
"column_id": "column-uuid"
}
]
}
'import requests
url = "https://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy"
payload = {
"sections": {
"goals": True,
"standalone_kpis": True,
"standalone_initiatives": True,
"assigned_issues": True,
"project_context": True,
"signals": True,
"attention": True
},
"signal_categories": {
"task": True,
"initiative": True,
"kpi": False,
"project": True
},
"project_ids": ["project-uuid"],
"initiative_ids": [],
"columns": [
{
"project_id": "project-uuid",
"column_id": "column-uuid"
}
]
}
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({
sections: {
goals: true,
standalone_kpis: true,
standalone_initiatives: true,
assigned_issues: true,
project_context: true,
signals: true,
attention: true
},
signal_categories: {task: true, initiative: true, kpi: false, project: true},
project_ids: ['project-uuid'],
initiative_ids: [],
columns: [{project_id: 'project-uuid', column_id: 'column-uuid'}]
})
};
fetch('https://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy', 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://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy",
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([
'sections' => [
'goals' => true,
'standalone_kpis' => true,
'standalone_initiatives' => true,
'assigned_issues' => true,
'project_context' => true,
'signals' => true,
'attention' => true
],
'signal_categories' => [
'task' => true,
'initiative' => true,
'kpi' => false,
'project' => true
],
'project_ids' => [
'project-uuid'
],
'initiative_ids' => [
],
'columns' => [
[
'project_id' => 'project-uuid',
'column_id' => 'column-uuid'
]
]
]),
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://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy"
payload := strings.NewReader("{\n \"sections\": {\n \"goals\": true,\n \"standalone_kpis\": true,\n \"standalone_initiatives\": true,\n \"assigned_issues\": true,\n \"project_context\": true,\n \"signals\": true,\n \"attention\": true\n },\n \"signal_categories\": {\n \"task\": true,\n \"initiative\": true,\n \"kpi\": false,\n \"project\": true\n },\n \"project_ids\": [\n \"project-uuid\"\n ],\n \"initiative_ids\": [],\n \"columns\": [\n {\n \"project_id\": \"project-uuid\",\n \"column_id\": \"column-uuid\"\n }\n ]\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://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sections\": {\n \"goals\": true,\n \"standalone_kpis\": true,\n \"standalone_initiatives\": true,\n \"assigned_issues\": true,\n \"project_context\": true,\n \"signals\": true,\n \"attention\": true\n },\n \"signal_categories\": {\n \"task\": true,\n \"initiative\": true,\n \"kpi\": false,\n \"project\": true\n },\n \"project_ids\": [\n \"project-uuid\"\n ],\n \"initiative_ids\": [],\n \"columns\": [\n {\n \"project_id\": \"project-uuid\",\n \"column_id\": \"column-uuid\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy")
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 \"sections\": {\n \"goals\": true,\n \"standalone_kpis\": true,\n \"standalone_initiatives\": true,\n \"assigned_issues\": true,\n \"project_context\": true,\n \"signals\": true,\n \"attention\": true\n },\n \"signal_categories\": {\n \"task\": true,\n \"initiative\": true,\n \"kpi\": false,\n \"project\": true\n },\n \"project_ids\": [\n \"project-uuid\"\n ],\n \"initiative_ids\": [],\n \"columns\": [\n {\n \"project_id\": \"project-uuid\",\n \"column_id\": \"column-uuid\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"avatar_url": "<string>"
},
"status": "default",
"is_default": true,
"saved_policy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_by_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sections": "<unknown>",
"signal_categories": "<unknown>",
"project_ids": "<unknown>",
"initiative_ids": "<unknown>",
"columns": "<unknown>"
},
"effective_policy": {
"sections": {
"goals": true,
"standalone_kpis": true,
"standalone_initiatives": true,
"assigned_issues": true,
"project_context": true,
"signals": true,
"attention": true
},
"signal_categories": {
"task": true,
"initiative": true,
"kpi": true,
"project": true
},
"project_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"initiative_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"columns": [
{
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"selectable": {
"projects": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"initiatives": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"project_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"columns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"label": "<string>",
"position": 123
}
]
},
"stale_selections": {
"project_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"initiative_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"columns": "<unknown>"
}
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}Agents
Replace an agent heartbeat policy
Atomically replaces the complete heartbeat policy after validating every selection against the target agent’s accessible scope.
PUT
/
api
/
orgs
/
{id}
/
agents
/
{agentId}
/
heartbeat-policy
Replace an agent heartbeat policy
curl --request PUT \
--url https://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sections": {
"goals": true,
"standalone_kpis": true,
"standalone_initiatives": true,
"assigned_issues": true,
"project_context": true,
"signals": true,
"attention": true
},
"signal_categories": {
"task": true,
"initiative": true,
"kpi": false,
"project": true
},
"project_ids": [
"project-uuid"
],
"initiative_ids": [],
"columns": [
{
"project_id": "project-uuid",
"column_id": "column-uuid"
}
]
}
'import requests
url = "https://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy"
payload = {
"sections": {
"goals": True,
"standalone_kpis": True,
"standalone_initiatives": True,
"assigned_issues": True,
"project_context": True,
"signals": True,
"attention": True
},
"signal_categories": {
"task": True,
"initiative": True,
"kpi": False,
"project": True
},
"project_ids": ["project-uuid"],
"initiative_ids": [],
"columns": [
{
"project_id": "project-uuid",
"column_id": "column-uuid"
}
]
}
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({
sections: {
goals: true,
standalone_kpis: true,
standalone_initiatives: true,
assigned_issues: true,
project_context: true,
signals: true,
attention: true
},
signal_categories: {task: true, initiative: true, kpi: false, project: true},
project_ids: ['project-uuid'],
initiative_ids: [],
columns: [{project_id: 'project-uuid', column_id: 'column-uuid'}]
})
};
fetch('https://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy', 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://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy",
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([
'sections' => [
'goals' => true,
'standalone_kpis' => true,
'standalone_initiatives' => true,
'assigned_issues' => true,
'project_context' => true,
'signals' => true,
'attention' => true
],
'signal_categories' => [
'task' => true,
'initiative' => true,
'kpi' => false,
'project' => true
],
'project_ids' => [
'project-uuid'
],
'initiative_ids' => [
],
'columns' => [
[
'project_id' => 'project-uuid',
'column_id' => 'column-uuid'
]
]
]),
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://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy"
payload := strings.NewReader("{\n \"sections\": {\n \"goals\": true,\n \"standalone_kpis\": true,\n \"standalone_initiatives\": true,\n \"assigned_issues\": true,\n \"project_context\": true,\n \"signals\": true,\n \"attention\": true\n },\n \"signal_categories\": {\n \"task\": true,\n \"initiative\": true,\n \"kpi\": false,\n \"project\": true\n },\n \"project_ids\": [\n \"project-uuid\"\n ],\n \"initiative_ids\": [],\n \"columns\": [\n {\n \"project_id\": \"project-uuid\",\n \"column_id\": \"column-uuid\"\n }\n ]\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://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sections\": {\n \"goals\": true,\n \"standalone_kpis\": true,\n \"standalone_initiatives\": true,\n \"assigned_issues\": true,\n \"project_context\": true,\n \"signals\": true,\n \"attention\": true\n },\n \"signal_categories\": {\n \"task\": true,\n \"initiative\": true,\n \"kpi\": false,\n \"project\": true\n },\n \"project_ids\": [\n \"project-uuid\"\n ],\n \"initiative_ids\": [],\n \"columns\": [\n {\n \"project_id\": \"project-uuid\",\n \"column_id\": \"column-uuid\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://atollhq.com/api/orgs/{id}/agents/{agentId}/heartbeat-policy")
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 \"sections\": {\n \"goals\": true,\n \"standalone_kpis\": true,\n \"standalone_initiatives\": true,\n \"assigned_issues\": true,\n \"project_context\": true,\n \"signals\": true,\n \"attention\": true\n },\n \"signal_categories\": {\n \"task\": true,\n \"initiative\": true,\n \"kpi\": false,\n \"project\": true\n },\n \"project_ids\": [\n \"project-uuid\"\n ],\n \"initiative_ids\": [],\n \"columns\": [\n {\n \"project_id\": \"project-uuid\",\n \"column_id\": \"column-uuid\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"avatar_url": "<string>"
},
"status": "default",
"is_default": true,
"saved_policy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_by_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sections": "<unknown>",
"signal_categories": "<unknown>",
"project_ids": "<unknown>",
"initiative_ids": "<unknown>",
"columns": "<unknown>"
},
"effective_policy": {
"sections": {
"goals": true,
"standalone_kpis": true,
"standalone_initiatives": true,
"assigned_issues": true,
"project_context": true,
"signals": true,
"attention": true
},
"signal_categories": {
"task": true,
"initiative": true,
"kpi": true,
"project": true
},
"project_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"initiative_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"columns": [
{
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"selectable": {
"projects": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"initiatives": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"project_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"columns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"label": "<string>",
"position": 123
}
]
},
"stale_selections": {
"project_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"initiative_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"columns": "<unknown>"
}
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Saved heartbeat policy management response
Show child attributes
Show child attributes
Available options:
default, customized Persisted policy. Stale focus IDs remain here so saved previews and real heartbeats fail closed until the sanitized editable policy is saved.
Show child attributes
Show child attributes
Sanitized editable form with stale selections removed.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Focus IDs retained by the saved runtime policy but removed from the editable effective policy.
Show child attributes
Show child attributes
⌘I