Skip to content

Adding docs #14597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 8, 2024
Merged

Adding docs #14597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dafb10e
docs for environment variables in private components
andrewjschuang Nov 7, 2024
184d4e4
warning in subscriptions api for git synced projects
andrewjschuang Nov 7, 2024
efb530b
update description
andrewjschuang Nov 7, 2024
9f7279c
update
andrewjschuang Nov 7, 2024
11559a7
update
andrewjschuang Nov 7, 2024
ee82b84
Merge branch 'master' into docs-improvements
andrewjschuang Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs-v2/pages/environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,10 @@ You can reference the value of environment variables using `{{process.env.YOUR_E
src="https://res.cloudinary.com/pipedreamin/image/upload/v1708551738/env-vars-feb-2024/env-vars-object-explorer-v2_x9afzl.png"
/>

<Callout type="info">
[Private components](https://pipedream.com/docs/components#using-components) (actions or triggers) do not have direct access to workspace or project variables as public components or code steps. Add a prop specifically for the variable you need. For sensitive data like API keys, [configure the prop as a secret](https://pipedream.com/docs/components/api#props). In your prop configuration, set the value to `{{process.env.YOUR_ENV_VAR}}` to securely reference the environment variable.
</Callout>

## Frequently Asked Questions

### What if I define the same variable key in my workspace env vars and project env vars?
Expand Down
8 changes: 6 additions & 2 deletions docs-v2/pages/rest-api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ The response from the request above will have a shape that looks like:
Pipedream uses conventional HTTP response codes to indicate the success or
failure of an API request:

- Codes in the `2xx` range indicate success.
- Codes in the `4xx` range indicate an error that failed (e.g., a required parameter was omitted).
- Codes in the `2xx` range indicate success.
- Codes in the `4xx` range indicate an error that failed (e.g., a required parameter was omitted).
- Codes in the `5xx` range indicate an error with Pipedream's server.

## Accounts
Expand Down Expand Up @@ -1073,6 +1073,10 @@ DELETE /sources/{id}

## Subscriptions

<Callout type="warning">
The Subscriptions API is currently incompatible with projects that have [GitHub Sync](https://pipedream.com/docs/projects/git) enabled. To [trigger another workflow](https://pipedream.com/docs/code/nodejs#invoke-another-workflow), use `$.flow.trigger` instead.
</Callout>

### Listen for events from another source or workflow

You can configure a source or workflow to receive events from any number of
Expand Down
Loading