client.app_categories.list()
-
-
-
Retrieve all available categories for integrated apps
-
-
-
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()
-
-
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.app_categories.retrieve(...)
-
-
-
Get details of a specific app category by its ID
-
-
-
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", )
-
-
-
id:
str— The ID of the app category to retrieve
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.apps.list(...)
-
-
-
Retrieve all available apps with optional filtering and sorting
-
-
-
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( after="after", before="before", limit=1, q="q", sort_key="name", sort_direction="asc", has_components=True, has_actions=True, has_triggers=True, ) for item in response: yield item # alternatively, you can paginate page-by-page for page in response.iter_pages(): yield page
-
-
-
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(...)
-
-
-
Get detailed information about a specific app by ID or name slug
-
-
-
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", )
-
-
-
app_id:
str— The name slug or ID of the app (e.g., 'slack', 'github')
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.accounts.list(...)
-
-
-
Retrieve all connected accounts for the project with optional filtering
-
-
-
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( external_user_id="external_user_id", oauth_app_id="oauth_app_id", after="after", before="before", limit=1, app="app", include_credentials=True, ) for item in response: yield item # alternatively, you can paginate page-by-page for page in response.iter_pages(): yield page
-
-
-
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(...)
-
-
-
Connect a new account for an external user in the project
-
-
-
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( external_user_id="external_user_id", oauth_app_id="oauth_app_id", app_slug="app_slug", cfmap_json="cfmap_json", connect_token="connect_token", )
-
-
-
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
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.accounts.retrieve(...)
-
-
-
Get the details for a specific connected account
-
-
-
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", include_credentials=True, )
-
-
-
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(...)
-
-
-
Remove a connected account and its associated credentials
-
-
-
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", )
-
-
-
account_id:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.accounts.delete_by_app(...)
-
-
-
Remove all connected accounts for a specific app
-
-
-
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", )
-
-
-
app_id:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.users.delete_external_user(...)
-
-
-
Remove an external user and all their associated accounts and resources
-
-
-
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", )
-
-
-
external_user_id:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.users.list(...)
-
-
-
Retrieve all external users for the project
-
-
-
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.users.list( after="after", before="before", limit=1, q="q", ) for item in response: yield item # alternatively, you can paginate page-by-page for page in response.iter_pages(): yield page
-
-
-
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.
-
-
client.components.list(...)
-
-
-
Retrieve available components with optional search and app filtering
-
-
-
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( after="after", before="before", limit=1, q="q", app="app", registry="public", component_type="trigger", ) for item in response: yield item # alternatively, you can paginate page-by-page for page in response.iter_pages(): yield page
-
-
-
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(...)
-
-
-
Get detailed configuration for a specific component by its key
-
-
-
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", version="1.2.3", )
-
-
-
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(...)
-
-
-
Retrieve remote options for a given prop for a component
-
-
-
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", )
-
-
-
id:
str— The component ID
-
external_user_id:
str— The external user ID
-
prop_name:
str— The name of the prop to configure
-
version:
typing.Optional[str]— Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
-
blocking:
typing.Optional[bool]— Whether this operation should block until completion
-
configured_props:
typing.Optional[ConfiguredProps]
-
dynamic_props_id:
typing.Optional[str]— The ID for dynamic props
-
page:
typing.Optional[float]— Page number for paginated results
-
prev_context:
typing.Optional[typing.Dict[str, 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(...)
-
-
-
Reload the prop definition based on the currently configured props
-
-
-
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", )
-
-
-
id:
str— The component ID
-
external_user_id:
str— The external user ID
-
version:
typing.Optional[str]— Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
-
blocking:
typing.Optional[bool]— Whether this operation should block until completion
-
configured_props:
typing.Optional[ConfiguredProps]
-
dynamic_props_id:
typing.Optional[str]— The ID for dynamic props
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.actions.list(...)
-
-
-
Retrieve available actions with optional search and app filtering
-
-
-
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( after="after", before="before", limit=1, q="q", app="app", registry="public", ) for item in response: yield item # alternatively, you can paginate page-by-page for page in response.iter_pages(): yield page
-
-
-
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(...)
-
-
-
Get detailed configuration for a specific action by its key
-
-
-
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", version="1.2.3", )
-
-
-
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(...)
-
-
-
Retrieve remote options for a given prop for a action
-
-
-
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", )
-
-
-
id:
str— The component ID
-
external_user_id:
str— The external user ID
-
prop_name:
str— The name of the prop to configure
-
version:
typing.Optional[str]— Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
-
blocking:
typing.Optional[bool]— Whether this operation should block until completion
-
configured_props:
typing.Optional[ConfiguredProps]
-
dynamic_props_id:
typing.Optional[str]— The ID for dynamic props
-
page:
typing.Optional[float]— Page number for paginated results
-
prev_context:
typing.Optional[typing.Dict[str, 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(...)
-
-
-
Reload the prop definition based on the currently configured props
-
-
-
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", )
-
-
-
id:
str— The component ID
-
external_user_id:
str— The external user ID
-
version:
typing.Optional[str]— Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
-
blocking:
typing.Optional[bool]— Whether this operation should block until completion
-
configured_props:
typing.Optional[ConfiguredProps]
-
dynamic_props_id:
typing.Optional[str]— The ID for dynamic props
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.actions.run(...)
-
-
-
Execute an action with the provided configuration and return results
-
-
-
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", )
-
-
-
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.
-
-
client.triggers.list(...)
-
-
-
Retrieve available triggers with optional search and app filtering
-
-
-
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( after="after", before="before", limit=1, q="q", app="app", registry="public", ) for item in response: yield item # alternatively, you can paginate page-by-page for page in response.iter_pages(): yield page
-
-
-
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(...)
-
-
-
Get detailed configuration for a specific trigger by its key
-
-
-
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", version="1.2.3", )
-
-
-
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(...)
-
-
-
Retrieve remote options for a given prop for a trigger
-
-
-
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", )
-
-
-
id:
str— The component ID
-
external_user_id:
str— The external user ID
-
prop_name:
str— The name of the prop to configure
-
version:
typing.Optional[str]— Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
-
blocking:
typing.Optional[bool]— Whether this operation should block until completion
-
configured_props:
typing.Optional[ConfiguredProps]
-
dynamic_props_id:
typing.Optional[str]— The ID for dynamic props
-
page:
typing.Optional[float]— Page number for paginated results
-
prev_context:
typing.Optional[typing.Dict[str, 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(...)
-
-
-
Reload the prop definition based on the currently configured props
-
-
-
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", )
-
-
-
id:
str— The component ID
-
external_user_id:
str— The external user ID
-
version:
typing.Optional[str]— Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
-
blocking:
typing.Optional[bool]— Whether this operation should block until completion
-
configured_props:
typing.Optional[ConfiguredProps]
-
dynamic_props_id:
typing.Optional[str]— The ID for dynamic props
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.triggers.deploy(...)
-
-
-
Deploy a trigger to listen for and emit events
-
-
-
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", )
-
-
-
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.
-
-
client.deployed_triggers.list(...)
-
-
-
Retrieve all deployed triggers for a specific external user
-
-
-
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( after="after", before="before", limit=1, external_user_id="external_user_id", emitter_type="email", ) for item in response: yield item # alternatively, you can paginate page-by-page for page in response.iter_pages(): yield page
-
-
-
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(...)
-
-
-
Get details of a specific deployed trigger by its ID
-
-
-
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", )
-
-
-
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(...)
-
-
-
Modify the configuration of a deployed trigger, including active status
-
-
-
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", )
-
-
-
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(...)
-
-
-
Remove a deployed trigger and stop receiving events
-
-
-
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", ignore_hook_errors=True, )
-
-
-
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(...)
-
-
-
Retrieve recent events emitted by a deployed trigger
-
-
-
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", n=1, )
-
-
-
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(...)
-
-
-
Get workflows connected to receive events from this trigger
-
-
-
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", )
-
-
-
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(...)
-
-
-
Connect or disconnect workflows to receive trigger events
-
-
-
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"], )
-
-
-
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(...)
-
-
-
Get webhook URLs configured to receive trigger events
-
-
-
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", )
-
-
-
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(...)
-
-
-
Configure webhook URLs to receive trigger events.
signing_keyis only returned for OAuth-authenticated requests.
-
-
-
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"], )
-
-
-
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.
-
-
client.deployed_triggers.retrieve_webhook(...)
-
-
-
Retrieve a specific webhook for a deployed trigger, including its signing key
-
-
-
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_webhook( trigger_id="trigger_id", webhook_id="webhook_id", external_user_id="external_user_id", )
-
-
-
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(...)
-
-
-
Regenerate the signing key for a specific webhook on a deployed trigger
-
-
-
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.regenerate_webhook_signing_key( trigger_id="trigger_id", webhook_id="webhook_id", external_user_id="external_user_id", )
-
-
-
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.project_environment.retrieve_webhook()
-
-
-
Retrieve the webhook configured for a project environment
-
-
-
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.project_environment.retrieve_webhook()
-
-
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.project_environment.update_webhook(...)
-
-
-
Create or update the webhook URL for a project environment. Creating a webhook returns
signing_key; updating an existing webhook does not.
-
-
-
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.project_environment.update_webhook( url="url", )
-
-
-
url:
str— The webhook URL to set
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.project_environment.delete_webhook()
-
-
-
Remove the webhook configured for a project environment
-
-
-
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.project_environment.delete_webhook()
-
-
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.project_environment.regenerate_webhook_signing_key()
-
-
-
Regenerate the signing key for the project environment webhook
-
-
-
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.project_environment.regenerate_webhook_signing_key()
-
-
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.projects.list(...)
-
-
-
List the projects that are available to the authenticated Connect client
-
-
-
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.projects.list( after="after", before="before", limit=1, q="q", ) for item in response: yield item # alternatively, you can paginate page-by-page for page in response.iter_pages(): yield page
-
-
-
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(...)
-
-
-
Create a new project for the authenticated workspace
-
-
-
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.create( name="name", )
-
-
-
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(...)
-
-
-
Get the project details for a specific project
-
-
-
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( project_id="project_id", )
-
-
-
project_id:
str— The project ID, which starts withproj_.
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.projects.delete(...)
-
-
-
Delete a project owned by the authenticated workspace
-
-
-
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.delete( project_id="project_id", )
-
-
-
project_id:
str— The project ID, which starts withproj_.
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.projects.update(...)
-
-
-
Update project details or application information
-
-
-
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.update( project_id="project_id", )
-
-
-
project_id:
str— The project ID, which starts withproj_.
-
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(...)
-
-
-
Upload or replace the project logo
-
-
-
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.update_logo( project_id="project_id", logo="data:image/png;base64,AAAAAA...", )
-
-
-
project_id:
str— The project ID, which starts withproj_.
-
logo:
str— Data URI containing the new Base64 encoded image
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.projects.retrieve_info()
-
-
-
Retrieve project configuration and environment details
-
-
-
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()
-
-
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.file_stash.download_file(...)
-
-
-
Download a file from File Stash
-
-
-
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.file_stash.download_file( s_3_key="s3_key", )
-
-
-
s_3_key:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration. You can pass in configuration such aschunk_size, and more to customize the request and response.
-
-
client.proxy.get(...)
-
-
-
Forward an authenticated GET request to an external API using an external user's account credentials
-
-
-
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", )
-
-
-
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. You can pass in configuration such aschunk_size, and more to customize the request and response.
-
-
client.proxy.post(...)
-
-
-
Forward an authenticated POST request to an external API using an external user's account credentials
-
-
-
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={"string": {"key": "value"}}, )
-
-
-
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_options:
typing.Optional[RequestOptions]— Request-specific configuration. You can pass in configuration such aschunk_size, and more to customize the request and response.
-
-
client.proxy.put(...)
-
-
-
Forward an authenticated PUT request to an external API using an external user's account credentials
-
-
-
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={"string": {"key": "value"}}, )
-
-
-
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_options:
typing.Optional[RequestOptions]— Request-specific configuration. You can pass in configuration such aschunk_size, and more to customize the request and response.
-
-
client.proxy.delete(...)
-
-
-
Forward an authenticated DELETE request to an external API using an external user's account credentials
-
-
-
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", )
-
-
-
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. You can pass in configuration such aschunk_size, and more to customize the request and response.
-
-
client.proxy.patch(...)
-
-
-
Forward an authenticated PATCH request to an external API using an external user's account credentials
-
-
-
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={"string": {"key": "value"}}, )
-
-
-
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_options:
typing.Optional[RequestOptions]— Request-specific configuration. You can pass in configuration such aschunk_size, and more to customize the request and response.
-
-
client.tokens.create(...)
-
-
-
Generate a Connect token to use for client-side authentication
-
-
-
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", )
-
-
-
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
-
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
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.tokens.validate(...)
-
-
-
Confirm the validity of a Connect token
-
-
-
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", app_id="app_id", oauth_app_id="oauth_app_id", )
-
-
-
ctok:
ConnectToken
-
app_id:
str— The app ID to validate against
-
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.
-
-
client.usage.list(...)
-
-
-
Retrieve Connect usage records for a time window
-
-
-
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.usage.list( start_ts=1, end_ts=1, )
-
-
-
start_ts:
int— Usage window start timestamp (seconds)
-
end_ts:
int— Usage window end timestamp (seconds)
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.oauth_tokens.create(...)
-
-
-
Exchange OAuth credentials for an access token
-
-
-
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", )
-
-
-
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.
-
-
client.workflows.invoke(...)
-
-
-
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, )
-
-
-
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(...)
-
-
-
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"}, )
-
-
-
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.
-
-