リファレンスHTTP APIAgents

Save whether the agent answers only when mentioned in Slack

PUT
/v1/agents/{id}/slack/app/settings

Saves mention_only for every channel of the agent that is in use, the ones already connected included; the next message reads it. DMs do not follow it. Agent managers with a web session only.

Auth: cookie session only; no scope. Idempotency-Key: required.

Authorization

cookieSession
cookie__Host-werft_session<token>

For the web console: the browser session cookie set by POST /v1/auth/login. It holds the scopes of the user's workspace role (owner: all; admin and member: all but sessions:recover). Requests other than GET must also send X-Requested-With: werft-web.

Path Parameters

id*string

The agent's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Header Parameters

Idempotency-Key*string

Required, 1–255 characters; a UUID per user intent works. A retry with the same key and the same body returns the original response and runs the command once; the same key with a different body answers 409 IDEMPOTENCY_CONFLICT. A missing or invalid key answers 400 BAD_REQUEST, after the body is read.

Length1 <= length <= 255
X-Requested-With?"werft-web"

Required with a cookie session: the literal werft-web.

Value in"werft-web"

Request Body

application/json
  1. body
mention_only*boolean

Response Body

The saved setting.

application/json
  1. response
mention_only*boolean
Example Request
curl -X PUT 'https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/slack/app/settings' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "mention_only": false}'
Example Response
{  "mention_only": true}