Looking for the Pipedream Connect API? Go here.
✅ Tokens are short-lived
✅ OAuth clients support scopes, limiting access to specific operations
✅ Limit access to specific Pipedream projects (coming soon)
OAuth
Workspace administrators can create OAuth clients in your workspace’s API settings. Since API requests are meant to be made server-side, and since grants are not tied to individual end users, all OAuth clients are Client Credentials applications.Creating an OAuth client
- Visit the API settings for your workspace.
- Click the New OAuth Client button.
- Name your client and click Create.
- Copy the client secret. It will not be accessible again. Click Close.
- Copy the client ID from the list.
How to get an access token
In the client credentials model, you exchange your OAuth client ID and secret for an access token. Then you use the access token to make API requests. If you’re running a server that executes JavaScript, we recommend using the Pipedream SDK, which automatically refreshes tokens for you./oauth/token
API endpoint:
Revoking a client secret
- Visit your workspace’s API settings.
- Click the … button to the right of the OAuth client whose secret you want to revoke, then click Rotate client secret.
- Copy the new client secret. It will not be accessible again.
OAuth security
See the OAuth section of the security docs for more information on how Pipedream secures OAuth credentials.User API keys
User API keys are only supported for a limited number of endpoints. You should use OAuth instead.
Revoking your API key
You can revoke your API key in your Account Settings (Settings -> Account). Click on the REVOKE button directly to the right of your API key. This will revoke your original API key, generating a new one. Any API requests made with the original token will yield a401 Unauthorized
error.
Authorizing API requests
Whether you use OAuth access tokens or user API keys, Pipedream uses Bearer Authentication to authorize your access to the API or SSE event streams. When you make API requests, pass anAuthorization
header of the following format:
cURL
to fetch profile information for the authenticated user:
Using the Pipedream CLI
You can link the CLI to your Pipedream account, which will automatically pass your API key in theAuthorization
header with every API request.