Sweep Connect
Sweep Connect lets your users connect Gmail, Google Drive, Outlook, OneDrive or Dropbox to Sweep without you building provider OAuth, token storage, consent screens or capability UX.
POST /v1/connect/sessionswith yourend_user_ref, the providers, the operation classes you need and aredirect_uri.- Send the user to the returned hosted
url(https://trustysweep.com/connect/…). It works on desktop and mobile; a return deep link is supported. - The user picks providers, sees exactly what each operation class allows, and consents. Provider OAuth runs inside Sweep.
- The user returns to your
redirect_uriwith?session=….GET /v1/connect/sessions/{id}gives you theconnection_id. - Use
connection_idon every call. You never receive a Google, Microsoft or Dropbox token.
Consent tiers
Section titled “Consent tiers”| Tier | Operation classes | Step-up |
|---|---|---|
| 1 | discover, monitor |
no |
| 2 | preserve, write, restore |
write/restore require an explicit step |
| 3 | remove, migrate, automate, billable_execute |
always an explicit step, per class |
A connection created for discover cannot silently become destructive: request broader classes with POST /v1/connections/{id}/step-up; the user re-consents.
Revocation
Section titled “Revocation”Users can revoke your connection from their account at any time; you can revoke with POST /v1/connections/{id}/revoke. Revocation halts execution immediately and emits sweep.connection.revoked.
Test mode
Section titled “Test mode”With a sk_test_ key the hosted flow uses the simulated provider and completes without a real provider login, so you can test the whole loop in CI.