Reference

AppCategories

client.app_categories.list() -> ListAppCategoriesResponse

📝 Description

Retrieve all available categories for integrated apps

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.app_categories.list()

⚙️ Parameters

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

client.app_categories.retrieve(...) -> GetAppCategoryResponse

📝 Description

Get details of a specific app category by its ID

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

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(...) -> ListAppsResponse

📝 Description

Retrieve all available apps with optional filtering and sorting

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.apps.list(
    after="after",
    before="before",
    limit=1,
    q="q",
    sort_key="name",
    sort_direction="asc",
    category_ids=[
        "category_ids"
    ],
    has_components=True,
    has_actions=True,
    has_triggers=True,
)

⚙️ 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

has_components: typing.Optional[bool] — Only return apps that have components (actions or triggers)

has_actions: typing.Optional[bool] — Only return apps that have actions

has_triggers: typing.Optional[bool] — Only return apps that have triggers

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

client.apps.retrieve(...) -> GetAppResponse

📝 Description

Get detailed information about a specific app by ID or name slug

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

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(...) -> ListAccountsResponse

📝 Description

Retrieve all connected accounts for the project with optional filtering

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.accounts.list(
    external_user_id="external_user_id",
    oauth_app_id="oauth_app_id",
    after="after",
    before="before",
    limit=1,
    app="app",
    include_credentials=True,
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

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

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(...) -> Account

📝 Description

Connect a new account for an external user in the project

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.accounts.create(
    external_user_id="external_user_id",
    oauth_app_id="oauth_app_id",
    app_slug="app_slug",
    cfmap_json="cfmap_json",
    connect_token="connect_token",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

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

account_id: typing.Optional[str] — An existing account ID to reconnect. When provided, the account's credentials are updated instead of creating a new account. Must belong to the same external user and project environment as the connect token, and match the app identified by app_slug.

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

client.accounts.retrieve(...) -> Account

📝 Description

Get the details for a specific connected account

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.accounts.retrieve(
    account_id="account_id",
    include_credentials=True,
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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(...)

📝 Description

Remove a connected account and its associated credentials

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.accounts.delete(
    account_id="account_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

account_id: str

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

client.accounts.delete_by_app(...)

📝 Description

Remove all connected accounts for a specific app

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.accounts.delete_by_app(
    app_id="app_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

app_id: str

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

Users

client.users.delete_external_user(...)

📝 Description

Remove an external user and all their associated accounts and resources

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.users.delete_external_user(
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

external_user_id: str

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

client.users.list(...) -> GetUsersResponse

📝 Description

Retrieve all external users for the project

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.users.list(
    after="after",
    before="before",
    limit=1,
    q="q",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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] — Filter users by external_id (partial match)

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

Components

client.components.list(...) -> GetComponentsResponse

📝 Description

Retrieve available components with optional search and app filtering

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.components.list(
    after="after",
    before="before",
    limit=1,
    q="q",
    app="app",
    registry="public",
    component_type="trigger",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

registry: typing.Optional[ComponentsListRequestRegistry] — The registry to retrieve components from. Defaults to 'all' ('public', 'private', or 'all')

component_type: typing.Optional[ComponentType] — The type of the component to filter the components

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

client.components.retrieve(...) -> GetComponentResponse

📝 Description

Get detailed configuration for a specific component by its key

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.components.retrieve(
    component_id="component_id",
    version="1.2.3",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

version: typing.Optional[str] — Optional semantic version of the component to retrieve (for example '1.0.0')

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

client.components.configure_prop(...) -> ConfigurePropResponse

📝 Description

Retrieve remote options for a given prop for a component

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.components.configure_prop(
    id="id",
    external_user_id="external_user_id",
    prop_name="prop_name",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

request: ConfigurePropOpts

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

client.components.reload_props(...) -> ReloadPropsResponse

📝 Description

Reload the prop definition based on the currently configured props

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.components.reload_props(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

request: ReloadPropsOpts

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

Actions

client.actions.list(...) -> GetComponentsResponse

📝 Description

Retrieve available actions with optional search and app filtering

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.actions.list(
    after="after",
    before="before",
    limit=1,
    q="q",
    app="app",
    registry="public",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

registry: typing.Optional[ActionsListRequestRegistry] — The registry to retrieve actions from. Defaults to 'all' ('public', 'private', or 'all')

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

client.actions.retrieve(...) -> GetComponentResponse

📝 Description

Get detailed configuration for a specific action by its key

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.actions.retrieve(
    component_id="component_id",
    version="1.2.3",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

version: typing.Optional[str] — Optional semantic version of the component to retrieve (for example '1.0.0')

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

client.actions.configure_prop(...) -> ConfigurePropResponse

📝 Description

Retrieve remote options for a given prop for a action

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.actions.configure_prop(
    id="id",
    external_user_id="external_user_id",
    prop_name="prop_name",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

request: ConfigurePropOpts

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

client.actions.reload_props(...) -> ReloadPropsResponse

📝 Description

Reload the prop definition based on the currently configured props

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.actions.reload_props(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

request: ReloadPropsOpts

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

client.actions.run(...) -> RunActionResponse

📝 Description

Execute an action with the provided configuration and return results

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.actions.run(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

id: str — The action component ID

external_user_id: str — The external user ID

version: typing.Optional[str] — Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest

configured_props: typing.Optional[ConfiguredProps]

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

stash_id: typing.Optional[RunActionOptsStashId]

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

Triggers

client.triggers.list(...) -> GetComponentsResponse

📝 Description

Retrieve available triggers with optional search and app filtering

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.triggers.list(
    after="after",
    before="before",
    limit=1,
    q="q",
    app="app",
    registry="public",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

registry: typing.Optional[TriggersListRequestRegistry] — The registry to retrieve triggers from. Defaults to 'all' ('public', 'private', or 'all')

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

client.triggers.retrieve(...) -> GetComponentResponse

📝 Description

Get detailed configuration for a specific trigger by its key

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.triggers.retrieve(
    component_id="component_id",
    version="1.2.3",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

version: typing.Optional[str] — Optional semantic version of the component to retrieve (for example '1.0.0')

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

client.triggers.configure_prop(...) -> ConfigurePropResponse

📝 Description

Retrieve remote options for a given prop for a trigger

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.triggers.configure_prop(
    id="id",
    external_user_id="external_user_id",
    prop_name="prop_name",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

request: ConfigurePropOpts

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

client.triggers.reload_props(...) -> ReloadPropsResponse

📝 Description

Reload the prop definition based on the currently configured props

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.triggers.reload_props(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

request: ReloadPropsOpts

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

client.triggers.deploy(...) -> DeployTriggerResponse

📝 Description

Deploy a trigger to listen for and emit events

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.triggers.deploy(
    id="id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

id: str — The trigger component ID

external_user_id: str — The external user ID

version: typing.Optional[str] — Optional trigger component version (in SemVer format, for example '1.0.0'), defaults to latest

configured_props: typing.Optional[ConfiguredProps]

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

workflow_id: typing.Optional[str] — Optional ID of a workflow to receive trigger events

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

emit_on_deploy: typing.Optional[bool] — Whether the trigger should emit events during the deploy hook execution. Defaults to true if not specified.

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

DeployedTriggers

client.deployed_triggers.list(...) -> GetTriggersResponse

📝 Description

Retrieve all deployed triggers for a specific external user

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.list(
    after="after",
    before="before",
    limit=1,
    external_user_id="external_user_id",
    emitter_type="email",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

emitter_type: typing.Optional[EmitterType] — Filter deployed triggers by emitter type (defaults to 'source' if not provided)

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

client.deployed_triggers.retrieve(...) -> GetTriggerResponse

📝 Description

Get details of a specific deployed trigger by its ID

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.retrieve(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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(...) -> GetTriggerResponse

📝 Description

Modify the configuration of a deployed trigger, including active status

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.update(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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[ConfiguredProps]

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

emit_on_deploy: typing.Optional[bool] — Whether the trigger should emit events during deployment

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

client.deployed_triggers.delete(...)

📝 Description

Remove a deployed trigger and stop receiving events

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.delete(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
    ignore_hook_errors=True,
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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(...) -> GetTriggerEventsResponse

📝 Description

Retrieve recent events emitted by a deployed trigger

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.list_events(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
    n=1,
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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(...) -> GetTriggerWorkflowsResponse

📝 Description

Get workflows connected to receive events from this trigger

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.list_workflows(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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(...) -> GetTriggerWorkflowsResponse

📝 Description

Connect or disconnect workflows to receive trigger events

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.update_workflows(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
    workflow_ids=[
        "workflow_ids"
    ],
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

trigger_id: str

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

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

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

client.deployed_triggers.list_webhooks(...) -> GetTriggerWebhooksResponse

📝 Description

Get webhook URLs configured to receive trigger events

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.list_webhooks(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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(...) -> GetTriggerWebhooksResponse

📝 Description

Configure webhook URLs to receive trigger events. signing_key is only returned for OAuth-authenticated requests.

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.update_webhooks(
    trigger_id="trigger_id",
    external_user_id="external_user_id",
    webhook_urls=[
        "webhook_urls"
    ],
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

trigger_id: str

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

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

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

client.deployed_triggers.retrieve_webhook(...) -> GetWebhookWithSigningKeyResponse

📝 Description

Retrieve a specific webhook for a deployed trigger, including its signing key

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.retrieve_webhook(
    trigger_id="trigger_id",
    webhook_id="webhook_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

trigger_id: str

webhook_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.regenerate_webhook_signing_key(...) -> GetWebhookWithSigningKeyResponse

📝 Description

Regenerate the signing key for a specific webhook on a deployed trigger

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.deployed_triggers.regenerate_webhook_signing_key(
    trigger_id="trigger_id",
    webhook_id="webhook_id",
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

trigger_id: str

webhook_id: str

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

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

ProjectEnvironment

client.project_environment.retrieve_webhook(...) -> GetWebhookResponse

📝 Description

Retrieve the webhook configured for a project environment

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.project_environment.retrieve_webhook()

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

client.project_environment.update_webhook(...) -> SetWebhookResponse

📝 Description

Create or update the webhook URL for a project environment. Creating a webhook returns signing_key; updating an existing webhook does not.

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.project_environment.update_webhook(
    url="url",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

url: str — The webhook URL to set

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

client.project_environment.delete_webhook(...)

📝 Description

Remove the webhook configured for a project environment

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.project_environment.delete_webhook()

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

client.project_environment.regenerate_webhook_signing_key(...) -> GetWebhookWithSigningKeyResponse

📝 Description

Regenerate the signing key for the project environment webhook

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.project_environment.regenerate_webhook_signing_key()

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

Projects

client.projects.list(...) -> ListProjectsResponse

📝 Description

List the projects that are available to the authenticated Connect client

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.projects.list(
    after="after",
    before="before",
    limit=1,
    q="q",
)

⚙️ 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 projects

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

client.projects.create(...) -> Project

📝 Description

Create a new project for the authenticated workspace

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.projects.create(
    name="name",
)

⚙️ Parameters

name: str — Name of the project

app_name: typing.Optional[str] — Display name for the Connect application

support_email: typing.Optional[str] — Support email displayed to end users

connect_require_key_auth_test: typing.Optional[bool] — Send a test request to the upstream API when adding Connect accounts for key-based apps

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

client.projects.retrieve(...) -> Project

📝 Description

Get the project details for a specific project

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.projects.retrieve(
    project_id="project_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

client.projects.delete(...)

📝 Description

Delete a project owned by the authenticated workspace

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.projects.delete(
    project_id="project_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

client.projects.update(...) -> Project

📝 Description

Update project details or application information

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.projects.update(
    project_id="project_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

name: typing.Optional[str] — Name of the project

app_name: typing.Optional[str] — Display name for the Connect application

support_email: typing.Optional[str] — Support email displayed to end users

connect_require_key_auth_test: typing.Optional[bool] — Send a test request to the upstream API when adding Connect accounts for key-based apps

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

client.projects.update_logo(...)

📝 Description

Upload or replace the project logo

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.projects.update_logo(
    project_id="project_id",
    logo="data:image/png;base64,AAAAAA...",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

logo: str — Data URI containing the new Base64 encoded image

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

client.projects.retrieve_info(...) -> ProjectInfoResponse

📝 Description

Retrieve project configuration and environment details

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.projects.retrieve_info()

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

FileStash

client.file_stash.download_file(...) -> typing.Iterator[bytes]

📝 Description

Download a file from File Stash

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.file_stash.download_file(
    s_3_key="s3_key",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

s_3_key: str

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

Proxy

client.proxy.get(...) -> typing.Iterator[bytes]

📝 Description

Forward an authenticated GET request to an external API using an external user's account credentials

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.proxy.get(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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(...) -> typing.Iterator[bytes]

📝 Description

Forward an authenticated POST request to an external API using an external user's account credentials

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.proxy.post(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
    request={
        "string": {"key": "value"}
    },
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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.Any] — Request body to forward to the target API

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

client.proxy.put(...) -> typing.Iterator[bytes]

📝 Description

Forward an authenticated PUT request to an external API using an external user's account credentials

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.proxy.put(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
    request={
        "string": {"key": "value"}
    },
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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.Any] — Request body to forward to the target API

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

client.proxy.delete(...) -> typing.Iterator[bytes]

📝 Description

Forward an authenticated DELETE request to an external API using an external user's account credentials

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.proxy.delete(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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(...) -> typing.Iterator[bytes]

📝 Description

Forward an authenticated PATCH request to an external API using an external user's account credentials

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.proxy.patch(
    url_64="url_64",
    external_user_id="external_user_id",
    account_id="account_id",
    request={
        "string": {"key": "value"}
    },
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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.Any] — Request body to forward to the target API

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

Tokens

client.tokens.create(...) -> CreateTokenResponse

📝 Description

Generate a Connect token to use for client-side authentication

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.tokens.create(
    external_user_id="external_user_id",
)

⚙️ Parameters

project_id: str — The project ID, which starts with proj_.

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

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

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

expires_in: typing.Optional[int] — Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.

scope: typing.Optional[str] — Space-separated scopes to restrict token permissions. Defaults to 'connect:*' if not specified. See https://pipedream.com/docs/connect/api-reference/authentication#connect-token-scopes for more information.

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

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

allow_progressive_scopes: typing.Optional[bool] — When true, end users may authorize a subset of the app's OAuth scopes; only the app's functional scopes (needed for the post-OAuth test request) are enforced. Defaults to false.

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

client.tokens.validate(...) -> ValidateTokenResponse

📝 Description

Confirm the validity of a Connect token

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.tokens.validate(
    ctok="ctok",
    app_id="app_id",
    account_id="account_id",
    oauth_app_id="oauth_app_id",
)

⚙️ Parameters

ctok: ConnectToken

app_id: str — The app ID to validate against

account_id: typing.Optional[str] — An existing account ID to reconnect. Must belong to the app identified by app_id.

oauth_app_id: typing.Optional[str] — The OAuth app ID to validate against (if the token is for an OAuth app)

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

Usage

client.usage.list(...) -> ConnectUsageResponse

📝 Description

Retrieve Connect usage records for a time window

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.usage.list(
    start_ts=1,
    end_ts=1,
)

⚙️ Parameters

start_ts: int — Usage window start timestamp (seconds)

end_ts: int — Usage window end timestamp (seconds)

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

OauthTokens

client.oauth_tokens.create(...) -> CreateOAuthTokenResponse

📝 Description

Exchange OAuth credentials for an access token

🔌 Usage

from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)

client.oauth_tokens.create(
    client_id="client_id",
    client_secret="client_secret",
)

⚙️ Parameters

grant_type: typing.Literal

client_id: str

client_secret: str

scope: typing.Optional[str] — Optional space-separated scopes for the access token. Defaults to *.

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

Workflows

client.workflows.invoke(...)

🔌 Usage

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

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)
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, PipedreamEnvironment

client = Pipedream(
    client_id="<clientId>",
    client_secret="<clientSecret>",
    environment=PipedreamEnvironment.PROD,
)
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.

FilesExpand file tree

reference.md

Latest commit

History

reference.md

File metadata and controls

Reference

AppCategories

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Apps

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Accounts

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Users

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Components

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Actions

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Triggers

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters