staqlydocs
REST APIAPI referenceChannels

Begin connecting an OAuth platform

Begin connecting an OAuth platform (channels:manage)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/v1/channels/oauth/{provider}/start

Answers the platform's authorization URL to send the browser to. The state is signed and bound to this browser with a short-lived cookie. Other query parameters are passed to the provider (instance for a Mastodon-style platform, say). The platform sends the browser back to the dashboard's /channels/callback/{provider} page, which hands the answer to the callback below.

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

provider*string

Query Parameters

instance?string

Platforms with many servers (Mastodon): the server's URL or host

Response Body

OK

application/json
  1. response
url*string
Formaturi
curl -X GET 'https://staqly.example.com/v1/channels/oauth/string/start'
{  "url": "http://example.com"}