Get the connection links of every connectable network
The authorization URL of each network, so the user can connect an account to this organization.
A network that cannot produce a link simply does not appear. That is a legitimate answer, not a failure: it is what happens with discord in an organization that has not saved its own bot credentials yet (see PUT /organizations/{id_organization}/social_credentials/{social_network}).
An app cannot call this. Connecting a social account is an OAuth flow with a person in front of it, so this endpoint only accepts a user token or a temporal connect token; with app credentials it answers error 519. The way an integration does it is to issue a temporal connect token with GET /organizations/{id_organization}/temporal_connect_token and hand it to its end user.
Read authorization, not link. Almost every network is redirect and you send the person to link. Two are not, and neither of them fails visibly if you treat it as one:
• WhatsApp is not a URL at all. Its sign-up is Meta's Embedded Signup, a popup you raise with the Facebook JavaScript SDK, so its link is an empty string and everything you need to open that popup travels in authorization. A client that loops over the list and redirects to link sends its user to its own page. • Telegram has a link and still is not a redirect. It opens a chat with the PlanVortex bot, and nobody comes back from it: the account is born minutes later, from the bot being added to a channel, and it is announced over the WebSocket. Open it in another tab and keep listening; redirect to it and there is nobody left to tell.
With a temporal token issued with account_selection=integrator the list has a single entry: the session's network, with the session's state inside its link. Any other link would go back through the hosted flow, which that token cannot use (error 554). Once the person has come back from the network the session is no longer waiting for a link, and this answers 551.
Request
- Base URL: https://api.planvortex.com/v1.0.0
- URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/connect_links
- Auth: one of:
- HTTP bearer
- OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)
Path parameters
Organization identifier
Query parameters
Only these networks. Repeat the parameter for several. Omit it and every connectable network comes back.
Which PlanVortex front the network sends the user back to, for a white-labelled deployment. It has to be one of the fronts the server has registered (FRONT_URL_REDIRECT) or the call answers error 532 — it is not your app's redirect_urls, and it cannot be a URL of yours: the networks only accept redirect URIs registered in their own app settings. Where your user goes once they have finished is the redirect_uri of GET /organizations/{id_organization}/temporal_connect_token.
Response
Successful operation
Changes
No recorded changes to this operation across all 1 revision of this API.