Channels

22 operations, generated from apps/api/openapi.yaml (OpenAPI 3.2). Each page has the parameters, request body, responses and code samples, and a Send button to try the request against your cloud instance.

• GET/v1/providersThe platform catalogThe platform catalog (channels:read)
• PUT/v1/providers/{id}/appRegister the workspace's own developer app for an OAuth platformRegister the workspace's own developer app for an OAuth platform (channels:manage)
• DELETE/v1/providers/{id}/appRemove the workspace's developer app for a platformRemove the workspace's developer app for a platform (channels:manage)
• GET/v1/channelsList connected channelsList connected channels (channels:read)
• POST/v1/channelsConnect a channel on a token platform, or your own automationConnect a channel on a token platform, or your own automation (channels:manage)
• GET/v1/channels/oauth/{provider}/startBegin connecting an OAuth platformBegin connecting an OAuth platform (channels:manage)
• GET/v1/channels/oauth/{provider}/callbackFinish connecting an OAuth platformFinish connecting an OAuth platform (channels:manage)
• GET/v1/channel-linksThe workspace's connect links, newest firstThe workspace's connect links, newest first (last 100); tokens are never shown again (channels:manage)
• POST/v1/channel-linksA link someone without access to Staqly opens to connect a channel to this workspaceA link someone without access to Staqly opens to connect a channel to this workspace (channels:manage)
• DELETE/v1/channel-links/{id}Stop a connect link from workingStop a connect link from working; channels already connected stay (channels:manage)
• GET/v1/connect-links/{token}What a connect link's page showsWhat a connect link's page shows (no credentials; the token is the key; 60 per 10 minutes per address)
• POST/v1/connect-links/{token}/channelsConnect a platform that signs in with a token, through a connect linkConnect a platform that signs in with a token, through a connect link (no credentials, no session)
• GET/v1/connect-links/{token}/oauth/{provider}/startBegin connecting an OAuth platform through a connect linkBegin connecting an OAuth platform through a connect link (no credentials)
• GET/v1/connect-links/oauth/{provider}/callbackFinish connecting an OAuth platform started from a connect linkFinish connecting an OAuth platform started from a connect link (no credentials)
• GET/v1/channels/{id}Get a channelGet a channel (channels:read); credentials are never returned
• DELETE/v1/channels/{id}Remove a channelRemove a channel; targets on it go with it (channels:manage)
• PATCH/v1/channels/{id}Rename, change defaults, turn off or on, or reconnect with fresh fieldsRename, change defaults, turn off or on, or reconnect with fresh fields (channels:manage)
• GET/v1/channel-groupsList channel groups with their channel countsList channel groups with their channel counts (channels:read)
• POST/v1/channel-groupsCreate a channel groupCreate a channel group (channels:manage)
• DELETE/v1/channel-groups/{id}Delete a channel groupDelete a channel group; its channels move to Default (channels:manage)
• PATCH/v1/channel-groups/{id}Rename a channel group or change its colour or positionRename a channel group or change its colour or position (channels:manage)
• POST/v1/channels/{id}/testCheck the stored credentials against the platformCheck the stored credentials against the platform (channels:manage)