Skip to content

Commit 1484f42

Browse files
Adding docs (#14597)
* docs for environment variables in private components * warning in subscriptions api for git synced projects * update description * update * update
1 parent d669da2 commit 1484f42

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

docs-v2/pages/environment-variables.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,10 @@ You can reference the value of environment variables using `{{process.env.YOUR_E
114114
src="https://res.cloudinary.com/pipedreamin/image/upload/v1708551738/env-vars-feb-2024/env-vars-object-explorer-v2_x9afzl.png"
115115
/>
116116

117+
<Callout type="info">
118+
[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.
119+
</Callout>
120+
117121
## Frequently Asked Questions
118122

119123
### What if I define the same variable key in my workspace env vars and project env vars?

docs-v2/pages/rest-api/index.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ The response from the request above will have a shape that looks like:
157157
Pipedream uses conventional HTTP response codes to indicate the success or
158158
failure of an API request:
159159

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

164164
## Accounts
@@ -1073,6 +1073,10 @@ DELETE /sources/{id}
10731073

10741074
## Subscriptions
10751075

1076+
<Callout type="warning">
1077+
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.
1078+
</Callout>
1079+
10761080
### Listen for events from another source or workflow
10771081

10781082
You can configure a source or workflow to receive events from any number of

0 commit comments

Comments
 (0)