/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Slack Bot Status

Get Slack Bot Status

The Slack bot's connection, masked credentials, behaviour settings, and the questions it answered this week.

GET/v1/projects/{projectId}/addons/slack_bot/statusTry it
Session token

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.

Note

Session JWT and org membership required. Any role can read it — an API key gets 401, a non-member 403. Any plan.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

Response Fields

NameDescription
data.botName:string | null
The bot user's name in Slack. null when Slack could not be reached or rejected the token.
data.workspace:object
•
name, 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.urlsVerifiedAt:string | null
The last time Slack reached Syntext's request URL with a valid signature, updated at most once an hour. null if it never has.
data.credentials:object
botToken and signingSecret, masked: a known Slack prefix (such as xoxb-), 16 dots, and the last four characters. The full values never leave Syntext.
data.settings:object
replyInThread, showSources and flagUnanswered. Change them with Update Slack Bot Settings.
data.recent:object

Questions asked of the bot in the last 7 days:

•
answeredThisWeek — answers that cited at least one docs source
•
helpfulPct — 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.connectionError:string | null
null 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:

json
{
"error": {
"code": "not_found",
"message": "The Slack bot is not connected for this project",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/addons/slack_bot/status \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": {
"botName": "syntext-docs",
"workspace": {
"name": "Acme",
"domain": "acme.slack.com",
"connectedBy": null,
"connectedAt": "2026-09-14T12:00:00.000Z",
"channels": ["#help-api", "#eng-support"]
},
"urlsVerifiedAt": "2026-11-08T07:31:09.000Z",
"credentials": {
"botToken": "xoxb-••••••••••••••••-7Qk2",
"signingSecret": "••••••••••••••••-a91f"
},
"settings": {
"replyInThread": true,
"showSources": true,
"flagUnanswered": true
},
"recent": {
"answeredThisWeek": 23,
"helpfulPct": 82,
"questions": [
{
"userId": "U04ABCD1234",
"where": "in #help-api",
"question": "How do I paginate the members list?",
"outcome": "answered",
"sources": 2
},
{
"userId": "U07WXYZ9876",
"where": "via /docs in #eng-support",
"question": "Is there a sandbox environment?",
"outcome": "flagged",
"sources": 0
}
]
},
"connectionError": null
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext