Report a Get set up step Workbot observed
curl --request POST \
--url https://api.openworklabs.com/v1/workbot/activation/events \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"durationMs": 43200000
}
'import requests
url = "https://api.openworklabs.com/v1/workbot/activation/events"
payload = { "durationMs": 43200000 }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({durationMs: 43200000})
};
fetch('https://api.openworklabs.com/v1/workbot/activation/events', 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/workbot/activation/events",
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([
'durationMs' => 43200000
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/workbot/activation/events"
payload := strings.NewReader("{\n \"durationMs\": 43200000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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://api.openworklabs.com/v1/workbot/activation/events")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"durationMs\": 43200000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/workbot/activation/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"durationMs\": 43200000\n}"
response = http.request(request)
puts response.read_body{
"steps": [
{
"id": "first_response",
"done": true,
"detail": "<string>",
"lockedReason": "<string>"
}
],
"dismissed": true
}{
"error": "<string>",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "insufficient_scope"
}{
"error": "feature_disabled",
"feature": "<string>"
}Workbot
Report a Get set up step Workbot observed
For the Workbot app only. With a live Workbot member token (read and write scopes), records the member’s first Workbot answer or that they hid the checklist, then returns the updated checklist. Repeats are ignored. Off unless the activationChecklist feature is on.
POST
/
v1
/
workbot
/
activation
/
events
Report a Get set up step Workbot observed
curl --request POST \
--url https://api.openworklabs.com/v1/workbot/activation/events \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"durationMs": 43200000
}
'import requests
url = "https://api.openworklabs.com/v1/workbot/activation/events"
payload = { "durationMs": 43200000 }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({durationMs: 43200000})
};
fetch('https://api.openworklabs.com/v1/workbot/activation/events', 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/workbot/activation/events",
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([
'durationMs' => 43200000
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/workbot/activation/events"
payload := strings.NewReader("{\n \"durationMs\": 43200000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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://api.openworklabs.com/v1/workbot/activation/events")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"durationMs\": 43200000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/workbot/activation/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"durationMs\": 43200000\n}"
response = http.request(request)
puts response.read_body{
"steps": [
{
"id": "first_response",
"done": true,
"detail": "<string>",
"lockedReason": "<string>"
}
],
"dismissed": true
}{
"error": "<string>",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "insufficient_scope"
}{
"error": "feature_disabled",
"feature": "<string>"
}Authorizations
denApiKeybearerAuth
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Body
application/json
Was this page helpful?