ReferenceHTTP APIAgents

The agent's Slack channel bindings

GET
/v1/agents/{id}/slack-bindings

Live bindings of the channels of the agent's Slack app, and its DM binding (surface_kind: dm, no external_surface_id): the home channel first, then oldest first; up to 500. Channel ids only; the console resolves names. A binding's status is ready (in use), pending_approval (a private channel waiting for an owner or admin) or left (the bot was removed from or left the private channel: inactive, no input is taken and nothing is sent there, membership.state is awaiting_invite, approved_at is null; its mode and ceiling are kept). Owners, admins, the agent's admins and the live members of its managing team.

Auth: cookie session only; no scope.

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

Response Body

Success

application/json
  1. response
items*array<>
Itemsitems <= 500
Example Request
curl -X GET 'https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/slack-bindings'
Example Response
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",      "owner_id": "string",      "surface": "web",      "installation_id": "91166175-c6a9-4caf-88e9-3147ffc9c934",      "external_surface_id": "string",      "surface_kind": "public_channel",      "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",      "mode": "off",      "ceiling": {        "actions": [          "session.read"        ],        "disclosure": "full"      },      "home": true,      "memory_write_policy": "deny",      "status": "ready",      "approved_at": "2019-08-24T14:15:22Z",      "membership": {        "state": "joined",        "error": "string"      },      "muted": true,      "revision": 0,      "created_at": "2019-08-24T14:15:22Z",      "revoked_at": "2019-08-24T14:15:22Z"    }  ]}