The Apps API is in beta. Its endpoints and responses may change.
Connect a connector
A person has to approve access in the provider’s own sign-in, so connecting takes three steps. To connect a connector:- Call List connectors and note the
integration_typeof the one you want. If it needs values such as an account subdomain, read them with Get connector connection fields. - Call Start connector connection and open the
redirect_urlit returns in a browser. The person signs in to the provider and approves access. - Poll Get connector connection status until
statusisACTIVEorFAILED.
redirect_url as a credential. Whoever approves access through it connects their provider account to the app.
Disconnect and remove a connector
Disconnect connector stops the app from using the connected account. Remove connector does that and also deletes the connector from the app, including its file in the app’s code, so connecting it again starts from scratch.Endpoints
- List connectors: List the connectors you can connect to an app.
- List connector connections: List the app’s connections and whether each still works.
- Get connector connection fields: Read the values a connector needs before you connect it.
- Start connector connection: Start an OAuth connection and get the sign-in link.
- Get connector connection status: Check where a connection you started stands.
- Disconnect connector: Disconnect a connector from the app.
- Remove connector: Remove a connector from the app completely.
- Get connector policies: Read which connectors the workspace lets builders and app users connect.