Skip to content
Docs

Connect a tool with OAuth

GET
/api/workspaces/{ws}/connections/{id}/oauth

For a connection with an OAuth app's client ID and secret (Linear): redirects the person to the tool to authorise Roster, then back to Integrations → Tools.

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).

id*string

The id of what the path names: a hire, a connection, a skill, a shared file, a department, a position, a goal or an approval.

Response Body

To the tool's authorise page.

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

Choose a connection's tools PUT

Which found tools hires can use at all (`enabled`; empty for all of them), and which ones people say change nothing (`readOnly`), so read-only hires get them. Each hire can be narrowed further on its Tools tab.

A tool's webhook check GET

Called by the tool, not by you: WhatsApp checks the address with its verify token here and gets its challenge back. The address to give it is this path with the connection's id.