v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01206322659.2 KB
projects

Connect or update a messaging channel binding. Upserts on (workforce, provider); credentials is write-only — omit to keep the stored secrets, null to clear them, an object to replace them.

put/orgs/{org_id}/projects/{project_id}/channels/{workforce}/{provider}

Path parameters

org_idstring required
project_idstring required
workforcestring required

Workforce component ref: manifest uid (canonical), numeric app id, or name — the server canonicalizes to the manifest uid.

providerstring required

Channel provider key (for example telegram, slack).

Request body

credentialsobject nullable

Provider secrets, write-only (never returned on any read). Omit to keep the stored credentials for this binding; null clears them; an object replaces them. Telegram: token (+ optional secret_token). Slack: bot_token + signing_secret.

enabledboolean

Soft toggle; defaults to true.

Response

Channel binding saved

{"stackTrail":"paths:/orgs/{org_id}/projects/{project_id}/channels/{workforce}/{provider}:put:responses:204:content:application/json:schema","oasType":"schema","type":"unknown","description":"Successful responses use HTTP 204 and do not include a body."}