Organizations

Get the settings for members' agents

Changed on

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), and the current "Your agent" template version (responsibilities and organization instructions). 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 the workbotProactive feature, Workbot on this deployment, and View OpenWork Models settings or Manage OpenWork Models.

get/v1/org/workbot-settings/proactive

Request

  • Base URL
    https://api.openworklabs.com
  • URL
    https://api.openworklabs.com/v1/org/workbot-settings/proactive
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Response

Agent settings returned.

slackReadyboolean required
runnerReadyboolean required

Changes