Skip to content

reference.md

Latest commit

 

History

History
4973 lines (3508 loc) · 58.3 KB

reference.md

File metadata and controls

4973 lines (3508 loc) · 58.3 KB

Reference

AppCategories

client.appCategories.list() -> List<AppCategory>

📝 Description

Retrieve all available categories for integrated apps

🔌 Usage

client.appCategories().list();
client.appCategories.retrieve(id) -> AppCategory

📝 Description

Get details of a specific app category by its ID

🔌 Usage

client.appCategories().retrieve("id");

⚙️ Parameters

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

Apps

client.apps.list() -> SyncPagingIterable<App>

📝 Description

Retrieve all available apps with optional filtering and sorting

🔌 Usage

client.apps().list(
    AppsListRequest
        .builder()
        .categoryIds(
            Arrays.asList("category_ids")
        )
        .after("after")
        .before("before")
        .limit(1)
        .q("q")
        .sortKey(AppsListRequestSortKey.NAME)
        .sortDirection(AppsListRequestSortDirection.ASC)
        .hasComponents(true)
        .hasActions(true)
        .hasTriggers(true)
        .build()
);

⚙️ Parameters

after: Optional<String> — The cursor to start from for pagination

before: Optional<String> — The cursor to end before for pagination

limit: Optional<Integer> — The maximum number of results to return

q: Optional<String> — A search query to filter the apps

sortKey: Optional<AppsListRequestSortKey> — The key to sort the apps by

sortDirection: Optional<AppsListRequestSortDirection> — The direction to sort the apps

categoryIds: Optional<String> — Only return apps in these categories

hasComponents: Optional<Boolean> — Only return apps that have components (actions or triggers)

hasActions: Optional<Boolean> — Only return apps that have actions

hasTriggers: Optional<Boolean> — Only return apps that have triggers

client.apps.retrieve(appId) -> GetAppResponse

📝 Description

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

🔌 Usage

client.apps().retrieve("app_id");

⚙️ Parameters

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

Accounts

client.accounts.list(projectId) -> SyncPagingIterable&lt;Account&gt;

📝 Description

Retrieve all connected accounts for the project with optional filtering

🔌 Usage

client.accounts().list(
    AccountsListRequest
        .builder()
        .externalUserId("external_user_id")
        .oauthAppId("oauth_app_id")
        .after("after")
        .before("before")
        .limit(1)
        .app("app")
        .includeCredentials(true)
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

externalUserId: Optional<String>

oauthAppId: Optional<String> — The OAuth app ID to filter by, if applicable

after: Optional<String> — The cursor to start from for pagination

before: Optional<String> — The cursor to end before for pagination

limit: Optional<Integer> — The maximum number of results to return

app: Optional<String> — The app slug or ID to filter accounts by.

includeCredentials: Optional<Boolean> — Whether to retrieve the account's credentials or not

client.accounts.create(projectId, request) -> Account

📝 Description

Connect a new account for an external user in the project

🔌 Usage

client.accounts().create(
    CreateAccountOpts
        .builder()
        .appSlug("app_slug")
        .cfmapJson("cfmap_json")
        .connectToken("connect_token")
        .externalUserId("external_user_id")
        .oauthAppId("oauth_app_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

externalUserId: Optional<String>

oauthAppId: Optional<String> — The OAuth app ID to filter by, if applicable

appSlug: String — The app slug for the account

cfmapJson: String — JSON string containing the custom fields mapping

connectToken: String — The connect token for authentication

name: Optional<String> — Optional name for the account

accountId: Optional<String> — 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.

client.accounts.retrieve(projectId, accountId) -> Account

📝 Description

Get the details for a specific connected account

🔌 Usage

client.accounts().retrieve(
    "account_id",
    AccountsRetrieveRequest
        .builder()
        .includeCredentials(true)
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

accountId: String

includeCredentials: Optional<Boolean> — Whether to retrieve the account's credentials or not

client.accounts.delete(projectId, accountId)

📝 Description

Remove a connected account and its associated credentials

🔌 Usage

client.accounts().delete("account_id");

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

accountId: String

client.accounts.deleteByApp(projectId, appId)

📝 Description

Remove all connected accounts for a specific app

🔌 Usage

client.accounts().deleteByApp("app_id");

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

appId: String

client.accounts.listByExternalUser(projectId, externalUserId) -> List&lt;Account&gt;

📝 Description

List all connected accounts for a specific external user. Equivalent to GET /accounts with external_user_id filter but uses path-based routing.

🔌 Usage

client.accounts().listByExternalUser(
    "external_user_id",
    AccountsListByExternalUserRequest
        .builder()
        .includeCredentials(true)
        .app("app")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

externalUserId: String

includeCredentials: Optional<Boolean>

app: Optional<String>

Users

client.users.deleteExternalUser(projectId, externalUserId)

📝 Description

Remove an external user and all their associated accounts and resources

🔌 Usage

client.users().deleteExternalUser("external_user_id");

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

externalUserId: String

client.users.list(projectId) -> SyncPagingIterable&lt;ExternalUser&gt;

📝 Description

Retrieve all external users for the project

🔌 Usage

client.users().list(
    UsersListRequest
        .builder()
        .after("after")
        .before("before")
        .limit(1)
        .q("q")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

after: Optional<String> — The cursor to start from for pagination

before: Optional<String> — The cursor to end before for pagination

limit: Optional<Integer> — The maximum number of results to return

q: Optional<String> — Filter users by external_id (partial match)

Components

client.components.list(projectId) -> SyncPagingIterable&lt;Component&gt;

📝 Description

Retrieve available components with optional search and app filtering

🔌 Usage

client.components().list(
    ComponentsListRequest
        .builder()
        .after("after")
        .before("before")
        .limit(1)
        .q("q")
        .app("app")
        .registry(ComponentsListRequestRegistry.PUBLIC)
        .componentType(ComponentType.TRIGGER)
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

after: Optional<String> — The cursor to start from for pagination

before: Optional<String> — The cursor to end before for pagination

limit: Optional<Integer> — The maximum number of results to return

q: Optional<String> — A search query to filter the components

app: Optional<String> — The ID or name slug of the app to filter the components

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

componentType: Optional<ComponentType> — The type of the component to filter the components

client.components.retrieve(projectId, componentId) -> GetComponentResponse

📝 Description

Get detailed configuration for a specific component by its key

🔌 Usage

client.components().retrieve(
    "component_id",
    ComponentsRetrieveRequest
        .builder()
        .version("1.2.3")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

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

version: Optional<String> — Optional semantic version of the component to retrieve (for example '1.0.0')

client.components.configureProp(projectId, request) -> ConfigurePropResponse

📝 Description

Retrieve remote options for a given prop for a component

🔌 Usage

client.components().configureProp(
    ConfigurePropOpts
        .builder()
        .id("id")
        .externalUserId("external_user_id")
        .propName("prop_name")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

request: ConfigurePropOpts

client.components.reloadProps(projectId, request) -> ReloadPropsResponse

📝 Description

Reload the prop definition based on the currently configured props

🔌 Usage

client.components().reloadProps(
    ReloadPropsOpts
        .builder()
        .id("id")
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

request: ReloadPropsOpts

Actions

client.actions.list(projectId) -> SyncPagingIterable&lt;Component&gt;

📝 Description

Retrieve available actions with optional search and app filtering

🔌 Usage

client.actions().list(
    ActionsListRequest
        .builder()
        .after("after")
        .before("before")
        .limit(1)
        .q("q")
        .app("app")
        .registry(ActionsListRequestRegistry.PUBLIC)
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

after: Optional<String> — The cursor to start from for pagination

before: Optional<String> — The cursor to end before for pagination

limit: Optional<Integer> — The maximum number of results to return

q: Optional<String> — A search query to filter the actions

app: Optional<String> — The ID or name slug of the app to filter the actions

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

client.actions.retrieve(projectId, componentId) -> GetComponentResponse

📝 Description

Get detailed configuration for a specific action by its key

🔌 Usage

client.actions().retrieve(
    "component_id",
    ActionsRetrieveRequest
        .builder()
        .version("1.2.3")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

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

version: Optional<String> — Optional semantic version of the component to retrieve (for example '1.0.0')

client.actions.configureProp(projectId, request) -> ConfigurePropResponse

📝 Description

Retrieve remote options for a given prop for a action

🔌 Usage

client.actions().configureProp(
    ConfigurePropOpts
        .builder()
        .id("id")
        .externalUserId("external_user_id")
        .propName("prop_name")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

request: ConfigurePropOpts

client.actions.reloadProps(projectId, request) -> ReloadPropsResponse

📝 Description

Reload the prop definition based on the currently configured props

🔌 Usage

client.actions().reloadProps(
    ReloadPropsOpts
        .builder()
        .id("id")
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

request: ReloadPropsOpts

client.actions.run(projectId, request) -> RunActionResponse

📝 Description

Execute an action with the provided configuration and return results

🔌 Usage

client.actions().run(
    RunActionOpts
        .builder()
        .id("id")
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

id: String — The action component ID

version: Optional<String> — Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest

externalUserId: String — The external user ID

configuredProps: Optional<Map<String, ConfiguredPropValue>>

dynamicPropsId: Optional<String> — The ID for dynamic props

stashId: Optional<RunActionOptsStashId>

Triggers

client.triggers.list(projectId) -> SyncPagingIterable&lt;Component&gt;

📝 Description

Retrieve available triggers with optional search and app filtering

🔌 Usage

client.triggers().list(
    TriggersListRequest
        .builder()
        .after("after")
        .before("before")
        .limit(1)
        .q("q")
        .app("app")
        .registry(TriggersListRequestRegistry.PUBLIC)
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

after: Optional<String> — The cursor to start from for pagination

before: Optional<String> — The cursor to end before for pagination

limit: Optional<Integer> — The maximum number of results to return

q: Optional<String> — A search query to filter the triggers

app: Optional<String> — The ID or name slug of the app to filter the triggers

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

client.triggers.retrieve(projectId, componentId) -> GetComponentResponse

📝 Description

Get detailed configuration for a specific trigger by its key

🔌 Usage

client.triggers().retrieve(
    "component_id",
    TriggersRetrieveRequest
        .builder()
        .version("1.2.3")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

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

version: Optional<String> — Optional semantic version of the component to retrieve (for example '1.0.0')

client.triggers.configureProp(projectId, request) -> ConfigurePropResponse

📝 Description

Retrieve remote options for a given prop for a trigger

🔌 Usage

client.triggers().configureProp(
    ConfigurePropOpts
        .builder()
        .id("id")
        .externalUserId("external_user_id")
        .propName("prop_name")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

request: ConfigurePropOpts

client.triggers.reloadProps(projectId, request) -> ReloadPropsResponse

📝 Description

Reload the prop definition based on the currently configured props

🔌 Usage

client.triggers().reloadProps(
    ReloadPropsOpts
        .builder()
        .id("id")
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

request: ReloadPropsOpts

client.triggers.deploy(projectId, request) -> DeployTriggerResponse

📝 Description

Deploy a trigger to listen for and emit events

🔌 Usage

client.triggers().deploy(
    DeployTriggerOpts
        .builder()
        .id("id")
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

id: String — The trigger component ID

version: Optional<String> — Optional trigger component version (in SemVer format, for example '1.0.0'), defaults to latest

externalUserId: String — The external user ID

configuredProps: Optional<Map<String, ConfiguredPropValue>>

dynamicPropsId: Optional<String> — The ID for dynamic props

workflowId: Optional<String> — Optional ID of a workflow to receive trigger events

webhookUrl: Optional<String> — Optional webhook URL to receive trigger events

emitOnDeploy: Optional<Boolean> — Whether the trigger should emit events during the deploy hook execution. Defaults to true if not specified.

DeployedTriggers

client.deployedTriggers.list(projectId) -> SyncPagingIterable&lt;Emitter&gt;

📝 Description

Retrieve all deployed triggers for a specific external user

🔌 Usage

client.deployedTriggers().list(
    DeployedTriggersListRequest
        .builder()
        .externalUserId("external_user_id")
        .after("after")
        .before("before")
        .limit(1)
        .emitterType(EmitterType.EMAIL)
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

after: Optional<String> — The cursor to start from for pagination

before: Optional<String> — The cursor to end before for pagination

limit: Optional<Integer> — The maximum number of results to return

externalUserId: String — Your end user ID, for whom you deployed the trigger

emitterType: Optional<EmitterType> — Filter deployed triggers by emitter type (defaults to 'source' if not provided)

client.deployedTriggers.retrieve(projectId, triggerId) -> GetTriggerResponse

📝 Description

Get details of a specific deployed trigger by its ID

🔌 Usage

client.deployedTriggers().retrieve(
    "trigger_id",
    DeployedTriggersRetrieveRequest
        .builder()
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

externalUserId: String — Your end user ID, for whom you deployed the trigger

client.deployedTriggers.update(projectId, triggerId, request) -> GetTriggerResponse

📝 Description

Modify the configuration of a deployed trigger, including active status

🔌 Usage

client.deployedTriggers().update(
    "trigger_id",
    UpdateTriggerOpts
        .builder()
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

externalUserId: String — The external user ID who owns the trigger

active: Optional<Boolean> — Whether the trigger should be active

configuredProps: Optional<Map<String, ConfiguredPropValue>>

name: Optional<String> — The name of the trigger

emitOnDeploy: Optional<Boolean> — Whether the trigger should emit events during deployment

client.deployedTriggers.delete(projectId, triggerId)

📝 Description

Remove a deployed trigger and stop receiving events

🔌 Usage

client.deployedTriggers().delete(
    "trigger_id",
    DeployedTriggersDeleteRequest
        .builder()
        .externalUserId("external_user_id")
        .ignoreHookErrors(true)
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

externalUserId: String — The external user ID who owns the trigger

ignoreHookErrors: Optional<Boolean> — Whether to ignore errors during deactivation hook

client.deployedTriggers.listEvents(projectId, triggerId) -> GetTriggerEventsResponse

📝 Description

Retrieve recent events emitted by a deployed trigger

🔌 Usage

client.deployedTriggers().listEvents(
    "trigger_id",
    DeployedTriggersListEventsRequest
        .builder()
        .externalUserId("external_user_id")
        .n(1)
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

externalUserId: String — Your end user ID, for whom you deployed the trigger

n: Optional<Integer> — The number of events to retrieve (defaults to 20 if not provided)

client.deployedTriggers.listWorkflows(projectId, triggerId) -> GetTriggerWorkflowsResponse

📝 Description

Get workflows connected to receive events from this trigger

🔌 Usage

client.deployedTriggers().listWorkflows(
    "trigger_id",
    DeployedTriggersListWorkflowsRequest
        .builder()
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

externalUserId: String — The external user ID who owns the trigger

client.deployedTriggers.updateWorkflows(projectId, triggerId, request) -> GetTriggerWorkflowsResponse

📝 Description

Connect or disconnect workflows to receive trigger events

🔌 Usage

client.deployedTriggers().updateWorkflows(
    "trigger_id",
    UpdateTriggerWorkflowsOpts
        .builder()
        .externalUserId("external_user_id")
        .workflowIds(
            Arrays.asList("workflow_ids")
        )
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

externalUserId: String — The external user ID who owns the trigger

workflowIds: List<String> — Array of workflow IDs to set

client.deployedTriggers.listWebhooks(projectId, triggerId) -> GetTriggerWebhooksResponse

📝 Description

Get webhook URLs configured to receive trigger events

🔌 Usage

client.deployedTriggers().listWebhooks(
    "trigger_id",
    DeployedTriggersListWebhooksRequest
        .builder()
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

externalUserId: String — The external user ID who owns the trigger

client.deployedTriggers.updateWebhooks(projectId, triggerId, request) -> GetTriggerWebhooksResponse

📝 Description

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

🔌 Usage

client.deployedTriggers().updateWebhooks(
    "trigger_id",
    UpdateTriggerWebhooksOpts
        .builder()
        .externalUserId("external_user_id")
        .webhookUrls(
            Arrays.asList("webhook_urls")
        )
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

externalUserId: String — The external user ID who owns the trigger

webhookUrls: List<String> — Array of webhook URLs to set

client.deployedTriggers.retrieveWebhook(projectId, triggerId, webhookId) -> GetWebhookWithSigningKeyResponse

📝 Description

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

🔌 Usage

client.deployedTriggers().retrieveWebhook(
    "trigger_id",
    "webhook_id",
    DeployedTriggersRetrieveWebhookRequest
        .builder()
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

webhookId: String

externalUserId: String — The external user ID who owns the trigger

client.deployedTriggers.regenerateWebhookSigningKey(projectId, triggerId, webhookId) -> GetWebhookWithSigningKeyResponse

📝 Description

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

🔌 Usage

client.deployedTriggers().regenerateWebhookSigningKey(
    "trigger_id",
    "webhook_id",
    DeployedTriggersRegenerateWebhookSigningKeyRequest
        .builder()
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

triggerId: String

webhookId: String

externalUserId: String — The external user ID who owns the trigger

ProjectEnvironment

client.projectEnvironment.retrieveWebhook(projectId) -> GetWebhookResponse

📝 Description

Retrieve the webhook configured for a project environment

🔌 Usage

client.projectEnvironment().retrieveWebhook();

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

client.projectEnvironment.updateWebhook(projectId, request) -> 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

client.projectEnvironment().updateWebhook(
    SetWebhookOpts
        .builder()
        .url("url")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

url: String — The webhook URL to set

client.projectEnvironment.deleteWebhook(projectId)

📝 Description

Remove the webhook configured for a project environment

🔌 Usage

client.projectEnvironment().deleteWebhook();

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

client.projectEnvironment.regenerateWebhookSigningKey(projectId) -> GetWebhookWithSigningKeyResponse

📝 Description

Regenerate the signing key for the project environment webhook

🔌 Usage

client.projectEnvironment().regenerateWebhookSigningKey();

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

Projects

client.projects.list() -> SyncPagingIterable&lt;Project&gt;

📝 Description

List the projects that are available to the authenticated Connect client

🔌 Usage

client.projects().list(
    ProjectsListRequest
        .builder()
        .after("after")
        .before("before")
        .limit(1)
        .q("q")
        .build()
);

⚙️ Parameters

after: Optional<String> — The cursor to start from for pagination

before: Optional<String> — The cursor to end before for pagination

limit: Optional<Integer> — The maximum number of results to return

q: Optional<String> — A search query to filter the projects

client.projects.create(request) -> Project

📝 Description

Create a new project for the authenticated workspace

🔌 Usage

client.projects().create(
    CreateProjectOpts
        .builder()
        .name("name")
        .build()
);

⚙️ Parameters

name: String — Name of the project

appName: Optional<String> — Display name for the Connect application

supportEmail: Optional<String> — Support email displayed to end users

connectRequireKeyAuthTest: Optional<Boolean> — Send a test request to the upstream API when adding Connect accounts for key-based apps

client.projects.retrieve(projectId) -> Project

📝 Description

Get the project details for a specific project

🔌 Usage

client.projects().retrieve("project_id");

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

client.projects.delete(projectId)

📝 Description

Delete a project owned by the authenticated workspace

🔌 Usage

client.projects().delete("project_id");

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

client.projects.update(projectId, request) -> Project

📝 Description

Update project details or application information

🔌 Usage

client.projects().update(
    "project_id",
    UpdateProjectOpts
        .builder()
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

name: Optional<String> — Name of the project

appName: Optional<String> — Display name for the Connect application

supportEmail: Optional<String> — Support email displayed to end users

connectRequireKeyAuthTest: Optional<Boolean> — Send a test request to the upstream API when adding Connect accounts for key-based apps

client.projects.updateLogo(projectId, request)

📝 Description

Upload or replace the project logo

🔌 Usage

client.projects().updateLogo(
    "project_id",
    UpdateProjectLogoOpts
        .builder()
        .logo("data:image/png;base64,AAAAAA...")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

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

client.projects.retrieveInfo(projectId) -> ProjectInfoResponse

📝 Description

Retrieve project configuration and environment details

🔌 Usage

client.projects().retrieveInfo();

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

FileStash

client.fileStash.downloadFile(projectId) -> InputStream

📝 Description

Download a file from File Stash

🔌 Usage

client.fileStash().downloadFile(
    FileStashDownloadFileRequest
        .builder()
        .s3Key("s3_key")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

s3Key: String

Proxy

The Proxy client forwards authenticated HTTP requests to a third-party API using credentials from a connected account stored in Pipedream Connect. Pass the target URL as a String (or okhttp3.HttpUrl) — the client Base64-encodes it internally before calling the Pipedream API.

Every method returns a ProxyResponse, which is a closeable union of either a parsed JSON value (response.isJson() / response.json()) or a raw InputStream (response.isStream() / response.stream()), determined by the upstream Content-Type. Stream responses should be consumed inside a try-with-resources block to release the underlying HTTP connection:

try (ProxyResponse response = client.proxy().get("https://api.example.com/users", request)) {
    if (response.isJson()) {
        Object json = response.json();
    } else {
        InputStream body = response.stream();
    }
}

For full HTTP metadata (status code, headers), use client.proxy().withRawResponse(). The async client (asyncClient.proxy().get(...)) exposes the same surface with CompletableFuture<ProxyResponse> return types.

client.proxy.get(url, request) -> ProxyResponse

📝 Description

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

🔌 Usage

client.proxy().get(
    "https://api.example.com/users",
    ProxyGetRequest
        .builder()
        .externalUserId("external_user_id")
        .accountId("account_id")
        .build()
);

⚙️ Parameters

url: String — Target URL to forward the request to. Base64-encoded internally before being sent to Pipedream. An okhttp3.HttpUrl overload is also available.

externalUserId: String — The external user ID for the proxy request

accountId: String — The account ID to use for authentication

client.proxy.post(url, request) -> ProxyResponse

📝 Description

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

🔌 Usage

client.proxy().post(
    "https://api.example.com/users",
    ProxyPostRequest
        .builder()
        .externalUserId("external_user_id")
        .accountId("account_id")
        .body(
            new HashMap<String, Object>() {{
                put("name", "Jane Doe");
                put("email", "jane@example.com");
            }}
        )
        .build()
);

⚙️ Parameters

url: String — Target URL to forward the request to. Base64-encoded internally before being sent to Pipedream. An okhttp3.HttpUrl overload is also available.

externalUserId: String — The external user ID for the proxy request

accountId: String — The account ID to use for authentication

body: Map<String, Object> — Request body to forward to the target API

client.proxy.put(url, request) -> ProxyResponse

📝 Description

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

🔌 Usage

client.proxy().put(
    "https://api.example.com/users/42",
    ProxyPutRequest
        .builder()
        .externalUserId("external_user_id")
        .accountId("account_id")
        .body(
            new HashMap<String, Object>() {{
                put("name", "Jane Doe");
                put("email", "jane@example.com");
            }}
        )
        .build()
);

⚙️ Parameters

url: String — Target URL to forward the request to. Base64-encoded internally before being sent to Pipedream. An okhttp3.HttpUrl overload is also available.

externalUserId: String — The external user ID for the proxy request

accountId: String — The account ID to use for authentication

body: Map<String, Object> — Request body to forward to the target API

client.proxy.delete(url, request) -> ProxyResponse

📝 Description

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

🔌 Usage

client.proxy().delete(
    "https://api.example.com/users/42",
    ProxyDeleteRequest
        .builder()
        .externalUserId("external_user_id")
        .accountId("account_id")
        .build()
);

⚙️ Parameters

url: String — Target URL to forward the request to. Base64-encoded internally before being sent to Pipedream. An okhttp3.HttpUrl overload is also available.

externalUserId: String — The external user ID for the proxy request

accountId: String — The account ID to use for authentication

client.proxy.patch(url, request) -> ProxyResponse

📝 Description

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

🔌 Usage

client.proxy().patch(
    "https://api.example.com/users/42",
    ProxyPatchRequest
        .builder()
        .externalUserId("external_user_id")
        .accountId("account_id")
        .body(
            new HashMap<String, Object>() {{
                put("email", "jane.new@example.com");
            }}
        )
        .build()
);

⚙️ Parameters

url: String — Target URL to forward the request to. Base64-encoded internally before being sent to Pipedream. An okhttp3.HttpUrl overload is also available.

externalUserId: String — The external user ID for the proxy request

accountId: String — The account ID to use for authentication

body: Map<String, Object> — Request body to forward to the target API

Tokens

client.tokens.create(projectId, request) -> CreateTokenResponse

📝 Description

Generate a Connect token to use for client-side authentication

🔌 Usage

client.tokens().create(
    CreateTokenOpts
        .builder()
        .externalUserId("external_user_id")
        .build()
);

⚙️ Parameters

projectId: String — The project ID, which starts with proj_.

allowedOrigins: Optional<List<String>> — List of allowed origins for CORS

errorRedirectUri: Optional<String> — URI to redirect to on error

expiresIn: Optional<Integer> — Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.

externalUserId: String — Your end user ID, for whom you're creating the token

scope: Optional<String> — 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.

successRedirectUri: Optional<String> — URI to redirect to on success

webhookUri: Optional<String> — Webhook URI for notifications

allowProgressiveScopes: Optional<Boolean> — 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.

client.tokens.validate(ctok) -> ValidateTokenResponse

📝 Description

Confirm the validity of a Connect token

🔌 Usage

client.tokens().validate(
    "ctok",
    TokensValidateRequest
        .builder()
        .appId("app_id")
        .accountId("account_id")
        .oauthAppId("oauth_app_id")
        .build()
);

⚙️ Parameters

ctok: String

appId: String — The app ID to validate against

accountId: Optional<String> — An existing account ID to reconnect. Must belong to the app identified by app_id.

oauthAppId: Optional<String> — The OAuth app ID to validate against (if the token is for an OAuth app)

Usage

client.usage.list() -> ConnectUsageResponse

📝 Description

Retrieve Connect usage records for a time window

🔌 Usage

client.usage().list(
    UsageListRequest
        .builder()
        .startTs(1)
        .endTs(1)
        .build()
);

⚙️ Parameters

startTs: Integer — Usage window start timestamp (seconds)

endTs: Integer — Usage window end timestamp (seconds)

OauthTokens

client.oauthTokens.create(request) -> CreateOAuthTokenResponse

📝 Description

Exchange OAuth credentials for an access token

🔌 Usage

client.oauthTokens().create(
    CreateOAuthTokenOpts
        .builder()
        .clientId("client_id")
        .clientSecret("client_secret")
        .build()
);

⚙️ Parameters

grantType: String

clientId: String

clientSecret: String

scope: Optional<String> — Optional space-separated scopes for the access token. Defaults to *.

Workflows

The Workflows client invokes a Pipedream workflow via its HTTP interface. Pass either a full workflow URL (https://eo3xxxx.m.pipedream.net) or just the endpoint ID (eo3xxxx). Both methods return the workflow's response body as a deserialized Object (typically a Map, List, or scalar — see Jackson's default deserialization). The async client (asyncClient.workflows().invoke(...) / invokeForExternalUser(...)) exposes the same two methods returning CompletableFuture<Object>.

client.workflows.invoke(urlOrEndpoint) -> Object

🔌 Usage

// Simple workflow invocation (uses OAuth authentication by default)
client.workflows().invoke("eo3xxxx");

// Advanced workflow invocation with all options
client.workflows().invoke(
    InvokeWorkflowOpts
        .builder()
        .urlOrEndpoint("https://eo3xxxx.m.pipedream.net")
        .body(
            new HashMap<String, Object>() {{
                put("name", "John Doe");
                put("email", "john@example.com");
            }}
        )
        .headers(
            new HashMap<String, String>() {{
                put("Content-Type", "application/json");
                put("Authorization", "Bearer your-token"); // For STATIC_BEARER auth
            }}
        )
        .method("POST")
        .authType(HTTPAuthType.STATIC_BEARER)
        .build()
);

⚙️ Parameters

urlOrEndpoint: String — Either a workflow endpoint ID (e.g., eo3xxxx) or a full workflow URL

body: Optional<Object> — Request body to send to the workflow (will be JSON serialized)

headers: Optional<Map<String, String>> — Additional headers to include in the request

method: Optional<String> — HTTP method to use (defaults to POST)

authType: Optional<HTTPAuthType> — Authentication type: OAUTH (default), STATIC_BEARER, or NONE

client.workflows.invokeForExternalUser(urlOrEndpoint, externalUserId) -> Object

🔌 Usage

// Simple external user invocation (uses OAuth authentication by default)
client.workflows().invokeForExternalUser("eo3xxxx", "user123");

// Advanced external user invocation with all options
client.workflows().invokeForExternalUser(
    InvokeWorkflowForExternalUserOpts
        .builder()
        .url("https://eo3xxxx.m.pipedream.net")
        .externalUserId("user123")
        .body(
            new HashMap<String, Object>() {{
                put("action", "process_data");
                put("data", Arrays.asList("item1", "item2"));
            }}
        )
        .headers(
            new HashMap<String, String>() {{
                put("X-Custom-Header", "value");
            }}
        )
        .method("POST")
        .authType(HTTPAuthType.OAUTH)
        .build()
);

⚙️ Parameters

url: String — The full workflow URL to invoke

externalUserId: String — Your end user ID, for whom you're invoking the workflow (Pipedream Connect)

body: Optional<Object> — Request body to send to the workflow (will be JSON serialized)

headers: Optional<Map<String, String>> — Additional headers to include in the request

method: Optional<String> — HTTP method to use (defaults to POST)

authType: Optional<HTTPAuthType> — Authentication type: OAUTH (default), STATIC_BEARER, or NONE