Get Slack Bot Status
The Slack bot's connection, masked credentials, behaviour settings, and the questions it answered this week.
Returns the state of the project's Slack bot: which workspace and channels it is connected to, masked credentials, its behaviour settings, and the questions people asked it in the last 7 days.
Session JWT and org membership required. Any role can read it — an API key gets 401, a non-member 403. Any plan.
Path Parameters
projectIdResponse Fields
data.botNamenull when Slack could not be reached or rejected the token.data.workspacename, domain — the Slack workspace, from Slack. Empty strings when Slack could not be reached.connectedAt — when the Slack bot add-on was set up for this project.connectedBy — who connected it. Currently always null.channels — channels the bot is a member of, as #name. Empty when Slack could not be reached.data.urlsVerifiedAtnull if it never has.data.credentialsbotToken and signingSecret, masked: a known Slack prefix (such as xoxb-), 16 dots, and the last four characters. The full values never leave Syntext.data.settingsdata.recentQuestions asked of the bot in the last 7 days:
answeredThisWeek — answers that cited at least one docs sourcehelpfulPct — that number as a share of all questions, 0–100 (0 with no questions). Slack has no helpful/unhelpful buttons, so this is the share answered with sources, not a rating.questions — the 10 newest: userId (the asker's Slack user ID, not a Syntext user), where (in #channel, in a direct message, or via /docs in #channel; channel C… when the channel name is unknown), question, outcome (answered with at least one source, otherwise flagged) and sources (how many were cited)data.connectionErrornull when Slack accepted the bot token. Otherwise Slack's error code (for example invalid_auth or token_revoked) or Slack could not be reached. The rest of the response is still returned, with the Slack-provided fields empty.Slack is asked for the workspace and channels on every call, with a 5-second limit each. The status is returned whenever credentials are saved, even while the Slack bot add-on is switched off.
Error Responses
401 Unauthorized
Missing, invalid or expired session JWT, or an API key.
403 Forbidden
You are not a member of the organization that owns the project.
404 Not Found
The project does not exist, or the Slack bot has no bot token and signing secret saved for this project: