curl --request GET \
--url https://api.openworklabs.com/v1/org/workbot-settings/proactive \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/org/workbot-settings/proactive"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/org/workbot-settings/proactive', 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://api.openworklabs.com/v1/org/workbot-settings/proactive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-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"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/org/workbot-settings/proactive"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.openworklabs.com/v1/org/workbot-settings/proactive")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/workbot-settings/proactive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"settings": {
"enabled": true,
"leadMinutes": 0,
"workingDays": "weekdays",
"startHour": 11,
"endHour": 12,
"dailyCap": 5,
"membersStart": "opted_in",
"destination": "workbot_dm",
"sources": {
"calendar": "everyone",
"connections": {},
"otherConnections": [
"<string>"
],
"toolOverrides": {}
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>"
},
"checkGate": true,
"checkGateThreshold": 0.5,
"sendCheck": true,
"sendCheckThreshold": 0.5
},
"template": {
"responsibilities": {
"morning_brief": true,
"meeting_prep": true,
"calendar_changes": true,
"waiting_on_you": true
},
"instructions": "<string>",
"versionId": "<string>",
"version": 4503599627370496
},
"slackReady": true,
"runnerReady": true,
"sourceConnections": {
"calendar": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"connectedMembers": 4503599627370495
}
],
"other": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"native": true,
"policy": "everyone"
}
],
"all": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"native": true,
"slots": [
"calendar"
],
"connectedMembers": 4503599627370495
}
]
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>",
"defaultText": "<string>",
"carriedOver": [
"checkEveryHours"
]
},
"checkGate": {
"model": true
},
"sendCheck": {
"ready": true
}
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "feature_disabled",
"feature": "<string>"
}Get the settings for members' agents
Returns how members’ agents work in this organization (Manage › Workbot): whether they are on, working hours, the daily limit per member, whether members start opted in, the default place messages go (a DM from the Workbot Slack app), what agents may read (settings.sources: calendar, and each connection by id under connections: everyone = on for everyone, members = members choose, off = not allowed; agents only ever read; the calendar is read through whichever calendar app the organization connected (Google Workspace or Microsoft 365), with no admin pick: each member’s agent reads exactly one, the one the member picked, else the one most members connected when their account on it is ready, else one they already connected; mail and chat are read through the Google Workspace, Microsoft 365 or Slack connection, under that connection’s policy; otherConnections = the connections agents may read, absent for every connection with reviewed read tools; with Your agent’s brief on (workbotAgentBrief) every connection is offered instead, MCP and Den’s own providers alike, each sourceConnections.other entry with the policy it has now, and toolOverrides = an admin’s per-tool choices per connection id (allow or deny)) with the organization’s connections behind each (sourceConnections.calendar, the calendar apps, each with connectedMembers, how many members connected their own account on it, null when unknown such as a shared credential; sourceConnections.other, every connection that is a source of its own; and sourceConnections.all, every connection an admin can add with where it can go) (sourceConnections, null without View connections; includes Google Workspace or Microsoft 365 set up before connections had their own entries), and the current “Your agent” template version (preset responsibilities and organization instructions). With Your agent’s brief on (workbotAgentBrief), brief is what agents follow instead of the responsibilities: checkEveryHours (a check every 1, 2, 3 or 4 hours inside working hours), dailyCap (messages per member per day), extraChecksPerDay (extra checks an agent may ask for before something time-sensitive), text (what to tell people, in plain text; defaultText is the built-in default) and carriedOver (fields not saved yet, carried over from the responsibilities, organization instructions and daily limit). Also says whether the Workbot Slack app is installed to send those DMs and whether the headless runner the agents run on is configured. Requires Workbot on this deployment, and View OpenWork Models settings or Manage OpenWork Models.
curl --request GET \
--url https://api.openworklabs.com/v1/org/workbot-settings/proactive \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/org/workbot-settings/proactive"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/org/workbot-settings/proactive', 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://api.openworklabs.com/v1/org/workbot-settings/proactive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-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"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/org/workbot-settings/proactive"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.openworklabs.com/v1/org/workbot-settings/proactive")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/workbot-settings/proactive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"settings": {
"enabled": true,
"leadMinutes": 0,
"workingDays": "weekdays",
"startHour": 11,
"endHour": 12,
"dailyCap": 5,
"membersStart": "opted_in",
"destination": "workbot_dm",
"sources": {
"calendar": "everyone",
"connections": {},
"otherConnections": [
"<string>"
],
"toolOverrides": {}
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>"
},
"checkGate": true,
"checkGateThreshold": 0.5,
"sendCheck": true,
"sendCheckThreshold": 0.5
},
"template": {
"responsibilities": {
"morning_brief": true,
"meeting_prep": true,
"calendar_changes": true,
"waiting_on_you": true
},
"instructions": "<string>",
"versionId": "<string>",
"version": 4503599627370496
},
"slackReady": true,
"runnerReady": true,
"sourceConnections": {
"calendar": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"connectedMembers": 4503599627370495
}
],
"other": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"native": true,
"policy": "everyone"
}
],
"all": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"native": true,
"slots": [
"calendar"
],
"connectedMembers": 4503599627370495
}
]
},
"brief": {
"checkEveryHours": 1,
"dailyCap": 5,
"extraChecksPerDay": 3,
"text": "<string>",
"defaultText": "<string>",
"carriedOver": [
"checkEveryHours"
]
},
"checkGate": {
"model": true
},
"sendCheck": {
"ready": true
}
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "feature_disabled",
"feature": "<string>"
}Authorizations
Response
Agent settings returned.
Was this page helpful?