Skip to content
Docs

How to set up a hire's Teams bot

GET
/api/workspaces/{ws}/teams/{connection}/hires/{hire}

The messaging endpoint to paste into the hire's bot, whether Teams can reach it (https), the bot ID saved so far and the pages to make the bot on. Save the bot's ID and client secret with PUT /hires/:id/chat/:connection (values appId, clientSecret); Roster checks them with Microsoft first.

Authorization

session
cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

connection*string

The connection's id (from GET /api/workspaces/:ws/connections).

hire*string

The hire's id.

Response Body

{ messagingEndpoint, https, tenantId, appId?, ready, links, permissions }.

Example Request
curl -X GET 'https://app.useroster.work/api/workspaces/string/teams/string/hires/string'
Example Response
Empty

Save Socket Mode tokens PUT

Only when Roster has no https address: the app's bot token and app-level token.

Download a hire's Teams app GET

A zip with the hire's Teams app manifest (its bot, name, role and the permission to read messages where it's added) and its two icons, to upload in Teams.