reference.md

Reference

AppCategories

client.app_categories.list()

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.app_categories.list()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.app_categories.retrieve(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.app_categories.retrieve(
    id="id",
)

⚙️ Parameters

id: str — The ID of the app category to retrieve

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Apps

client.apps.list(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
response = client.apps.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

after: typing.Optional[str] — The cursor to start from for pagination

before: typing.Optional[str] — The cursor to end before for pagination

limit: typing.Optional[int] — The maximum number of results to return

q: typing.Optional[str] — A search query to filter the apps

sort_key: typing.Optional[AppsListRequestSortKey] — The key to sort the apps by

sort_direction: typing.Optional[AppsListRequestSortDirection] — The direction to sort the apps

category_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] — Only return apps in these categories

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.apps.retrieve(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.apps.retrieve(
    app_id="app_id",
)

⚙️ Parameters

app_id: str — The name slug or ID of the app (e.g., 'slack', 'github')

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Accounts

client.accounts.list(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
response = client.accounts.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

app_id: typing.Optional[str] — The app slug or ID to filter accounts by.

external_user_id: typing.Optional[str]

oauth_app_id: typing.Optional[str] — The OAuth app ID to filter by, if applicable

after: typing.Optional[str] — The cursor to start from for pagination

before: typing.Optional[str] — The cursor to end before for pagination

limit: typing.Optional[int] — The maximum number of results to return

include_credentials: typing.Optional[bool] — Whether to retrieve the account's credentials or not

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.accounts.create(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.accounts.create(
    app_slug="app_slug",
    cfmap_json="cfmap_json",
    connect_token="connect_token",
)

⚙️ Parameters

app_slug: str — The app slug for the account

cfmap_json: str — JSON string containing the custom fields mapping

connect_token: str — The connect token for authentication

app_id: typing.Optional[str] — The app slug or ID to filter accounts by.

external_user_id: typing.Optional[str]

oauth_app_id: typing.Optional[str] — The OAuth app ID to filter by, if applicable

name: typing.Optional[str] — Optional name for the account

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.accounts.retrieve(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.accounts.retrieve(
    account_id="account_id",
)

⚙️ Parameters

account_id: str

include_credentials: typing.Optional[bool] — Whether to retrieve the account's credentials or not

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.accounts.delete(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.accounts.delete(
    account_id="account_id",
)

⚙️ Parameters

account_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.accounts.delete_by_app(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.accounts.delete_by_app(
    app_id="app_id",
)

⚙️ Parameters

app_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Users

client.users.delete_external_user(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.users.delete_external_user(
    external_user_id="external_user_id",
)

⚙️ Parameters

external_user_id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Components

client.components.list(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
response = client.components.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

after: typing.Optional[str] — The cursor to start from for pagination

before: typing.Optional[str] — The cursor to end before for pagination

limit: typing.Optional[int] — The maximum number of results to return

q: typing.Optional[str] — A search query to filter the components

app: typing.Optional[str] — The ID or name slug of the app to filter the components

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.components.retrieve(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.components.retrieve(
    component_id="component_id",
)

⚙️ Parameters

component_id: str — The key that uniquely identifies the component (e.g., 'slack-send-message')

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.components.configure_prop(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.components.configure_prop(
    id="id",
    external_user_id="external_user_id",
    prop_name="prop_name",
)

⚙️ Parameters

id: str — The component ID

external_user_id: str — The external user ID

prop_name: str — The name of the prop to configure

async_handle: typing.Optional[str]

blocking: typing.Optional[bool] — Whether this operation should block until completion

configured_props: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — The configured properties for the component

dynamic_props_id: typing.Optional[str] — The ID for dynamic props

configure_prop_opts_async_handle: typing.Optional[str] — Handle for async operations

page: typing.Optional[float] — Page number for paginated results

prev_context: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — Previous context for pagination

query: typing.Optional[str] — Search query for filtering options

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.components.reload_props(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.components.reload_props(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

id: str — The component ID

external_user_id: str — The external user ID

async_handle: typing.Optional[str]

blocking: typing.Optional[bool] — Whether this operation should block until completion

configured_props: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — The configured properties for the component

dynamic_props_id: typing.Optional[str] — The ID for dynamic props

reload_props_opts_async_handle: typing.Optional[str] — Handle for async operations

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Actions

client.actions.list(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
response = client.actions.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

after: typing.Optional[str] — The cursor to start from for pagination

before: typing.Optional[str] — The cursor to end before for pagination

limit: typing.Optional[int] — The maximum number of results to return

q: typing.Optional[str] — A search query to filter the actions

app: typing.Optional[str] — The ID or name slug of the app to filter the actions

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.actions.retrieve(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.actions.retrieve(
    component_id="component_id",
)

⚙️ Parameters

component_id: str — The key that uniquely identifies the component (e.g., 'slack-send-message')

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.actions.configure_prop(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.actions.configure_prop(
    id="id",
    external_user_id="external_user_id",
    prop_name="prop_name",
)

⚙️ Parameters

id: str — The component ID

external_user_id: str — The external user ID

prop_name: str — The name of the prop to configure

async_handle: typing.Optional[str]

blocking: typing.Optional[bool] — Whether this operation should block until completion

configured_props: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — The configured properties for the component

dynamic_props_id: typing.Optional[str] — The ID for dynamic props

configure_prop_opts_async_handle: typing.Optional[str] — Handle for async operations

page: typing.Optional[float] — Page number for paginated results

prev_context: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — Previous context for pagination

query: typing.Optional[str] — Search query for filtering options

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.actions.reload_props(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.actions.reload_props(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

id: str — The component ID

external_user_id: str — The external user ID

async_handle: typing.Optional[str]

blocking: typing.Optional[bool] — Whether this operation should block until completion

configured_props: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — The configured properties for the component

dynamic_props_id: typing.Optional[str] — The ID for dynamic props

reload_props_opts_async_handle: typing.Optional[str] — Handle for async operations

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.actions.run(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.actions.run(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

id: str — The action component ID

external_user_id: str — The external user ID

async_handle: typing.Optional[str]

configured_props: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — The configured properties for the action

dynamic_props_id: typing.Optional[str] — The ID for dynamic props

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Triggers

client.triggers.list(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
response = client.triggers.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

after: typing.Optional[str] — The cursor to start from for pagination

before: typing.Optional[str] — The cursor to end before for pagination

limit: typing.Optional[int] — The maximum number of results to return

q: typing.Optional[str] — A search query to filter the triggers

app: typing.Optional[str] — The ID or name slug of the app to filter the triggers

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.triggers.retrieve(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.triggers.retrieve(
    component_id="component_id",
)

⚙️ Parameters

component_id: str — The key that uniquely identifies the component (e.g., 'slack-send-message')

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.triggers.configure_prop(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.triggers.configure_prop(
    id="id",
    external_user_id="external_user_id",
    prop_name="prop_name",
)

⚙️ Parameters

id: str — The component ID

external_user_id: str — The external user ID

prop_name: str — The name of the prop to configure

async_handle: typing.Optional[str]

blocking: typing.Optional[bool] — Whether this operation should block until completion

configured_props: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — The configured properties for the component

dynamic_props_id: typing.Optional[str] — The ID for dynamic props

configure_prop_opts_async_handle: typing.Optional[str] — Handle for async operations

page: typing.Optional[float] — Page number for paginated results

prev_context: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — Previous context for pagination

query: typing.Optional[str] — Search query for filtering options

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.triggers.reload_props(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.triggers.reload_props(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

id: str — The component ID

external_user_id: str — The external user ID

async_handle: typing.Optional[str]

blocking: typing.Optional[bool] — Whether this operation should block until completion

configured_props: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — The configured properties for the component

dynamic_props_id: typing.Optional[str] — The ID for dynamic props

reload_props_opts_async_handle: typing.Optional[str] — Handle for async operations

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.triggers.deploy(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.triggers.deploy(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

id: str — The trigger component ID

external_user_id: str — The external user ID

configured_props: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — The configured properties for the trigger

dynamic_props_id: typing.Optional[str] — The ID for dynamic props

webhook_url: typing.Optional[str] — Optional webhook URL to receive trigger events

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

DeployedTriggers

client.deployed_triggers.list(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
response = client.deployed_triggers.list(
    external_user_id="external_user_id",
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

external_user_id: str — Your end user ID, for whom you deployed the trigger

after: typing.Optional[str] — The cursor to start from for pagination

before: typing.Optional[str] — The cursor to end before for pagination

limit: typing.Optional[int] — The maximum number of results to return

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.deployed_triggers.retrieve(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.deployed_triggers.retrieve(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

trigger_id: str

external_user_id: str — Your end user ID, for whom you deployed the trigger

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.deployed_triggers.update(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.deployed_triggers.update(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

trigger_id: str

external_user_id: str — The external user ID who owns the trigger

active: typing.Optional[bool] — Whether the trigger should be active

configured_props: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] — The configured properties for the trigger

name: typing.Optional[str] — The name of the trigger

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.deployed_triggers.delete(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.deployed_triggers.delete(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

trigger_id: str

external_user_id: str — The external user ID who owns the trigger

ignore_hook_errors: typing.Optional[bool] — Whether to ignore errors during deactivation hook

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.deployed_triggers.list_events(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.deployed_triggers.list_events(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

trigger_id: str

external_user_id: str — Your end user ID, for whom you deployed the trigger

n: typing.Optional[int] — The number of events to retrieve (defaults to 20 if not provided)

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.deployed_triggers.list_workflows(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.deployed_triggers.list_workflows(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

trigger_id: str

external_user_id: str — The external user ID who owns the trigger

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.deployed_triggers.update_workflows(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.deployed_triggers.update_workflows(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
    workflow_ids=["workflow_ids"],
)

⚙️ Parameters

trigger_id: str

external_user_id: str — The external user ID who owns the trigger

workflow_ids: typing.Sequence[str] — Array of workflow IDs to set

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.deployed_triggers.list_webhooks(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.deployed_triggers.list_webhooks(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

trigger_id: str

external_user_id: str — The external user ID who owns the trigger

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.deployed_triggers.update_webhooks(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.deployed_triggers.update_webhooks(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
    webhook_urls=["webhook_urls"],
)

⚙️ Parameters

trigger_id: str

external_user_id: str — The external user ID who owns the trigger

webhook_urls: typing.Sequence[str] — Array of webhook URLs to set

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Projects

client.projects.retrieve_info()

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.projects.retrieve_info()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Proxy

client.proxy.get(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.proxy.get(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
)

⚙️ Parameters

url_64: str — Base64-encoded target URL

external_user_id: str — The external user ID for the proxy request

account_id: str — The account ID to use for authentication

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.proxy.post(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.proxy.post(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
    request={"key": "value"},
)

⚙️ Parameters

url_64: str — Base64-encoded target URL

external_user_id: str — The external user ID for the proxy request

account_id: str — The account ID to use for authentication

request: typing.Dict[str, typing.Optional[typing.Any]]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.proxy.put(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.proxy.put(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
    request={"key": "value"},
)

⚙️ Parameters

url_64: str — Base64-encoded target URL

external_user_id: str — The external user ID for the proxy request

account_id: str — The account ID to use for authentication

request: typing.Dict[str, typing.Optional[typing.Any]]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.proxy.delete(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.proxy.delete(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
)

⚙️ Parameters

url_64: str — Base64-encoded target URL

external_user_id: str — The external user ID for the proxy request

account_id: str — The account ID to use for authentication

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.proxy.patch(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.proxy.patch(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
    request={"key": "value"},
)

⚙️ Parameters

url_64: str — Base64-encoded target URL

external_user_id: str — The external user ID for the proxy request

account_id: str — The account ID to use for authentication

request: typing.Dict[str, typing.Optional[typing.Any]]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Tokens

client.tokens.create(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.tokens.create(
    external_user_id="external_user_id",
)

⚙️ Parameters

external_user_id: str — Your end user ID, for whom you're creating the token

allowed_origins: typing.Optional[typing.Sequence[str]] — List of allowed origins for CORS

error_redirect_uri: typing.Optional[str] — URI to redirect to on error

success_redirect_uri: typing.Optional[str] — URI to redirect to on success

webhook_uri: typing.Optional[str] — Webhook URI for notifications

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.tokens.validate(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.tokens.validate(
    ctok="ctok",
)

⚙️ Parameters

ctok: str

params: typing.Optional[ValidateTokenParams]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

OauthTokens

client.oauth_tokens.create(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client.oauth_tokens.create(
    client_id="client_id",
    client_secret="client_secret",
)

⚙️ Parameters

client_id: str

client_secret: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Workflows

client.workflows.invoke(...)

🔌 Usage

from pipedream import Pipedream
from pipedream.workflows.client import HTTPAuthType

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
response = client.workflows.invoke(
    url_or_endpoint="https://your-workflow.m.pipedream.net",
    method="POST",
    body={"key": "value"},
    headers={"Content-Type": "application/json"},
    auth_type=HTTPAuthType.NONE,
)

⚙️ Parameters

url_or_endpoint: str — The URL of the workflow's HTTP interface or the ID of the endpoint

method: str — HTTP method to use (default: "POST")

body: typing.Optional[typing.Any] — Request body data

headers: typing.Optional[typing.Dict[str, str]] — HTTP headers to include

auth_type: HTTPAuthType — Type of authorization (default: HTTPAuthType.NONE)

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.workflows.invoke_for_external_user(...)

🔌 Usage

from pipedream import Pipedream

client = Pipedream(
    project_id="YOUR_PROJECT_ID",
    project_environment="YOUR_PROJECT_ENVIRONMENT",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
response = client.workflows.invoke_for_external_user(
    url_or_endpoint="en2r1n8a98np7",
    external_user_id="user_123",
    method="POST",
    body={"message": "Hello from external user"},
    headers={"Content-Type": "application/json"},
)

⚙️ Parameters

url_or_endpoint: str — The URL of the workflow's HTTP interface or the ID of the endpoint

external_user_id: str — The external user ID for whom the workflow is being invoked

method: str — HTTP method to use (default: "POST")

body: typing.Optional[typing.Any] — Request body data

headers: typing.Optional[typing.Dict[str, str]] — HTTP headers to include

request_options: typing.Optional[RequestOptions] — Request-specific configuration.