From f402062b32ea17793b8f14bfd3012ec54a43067c Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Mon, 27 Apr 2026 19:48:55 +0000 Subject: [PATCH 1/3] SDK regeneration --- README.md | 4 +- build.gradle | 4 +- reference.md | 2880 +++++++++++++---- .../com/pipedream/api/core/ClientOptions.java | 4 +- 4 files changed, 2244 insertions(+), 648 deletions(-) diff --git a/README.md b/README.md index 69021da..cfa97c3 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Add the dependency in your `build.gradle` file: ```groovy dependencies { - implementation 'com.pipedream:pipedream:1.1.12' + implementation 'com.pipedream:pipedream:1.1.13' } ``` @@ -40,7 +40,7 @@ Add the dependency in your `pom.xml` file: com.pipedream pipedream - 1.1.12 + 1.1.13 ``` diff --git a/build.gradle b/build.gradle index 0a47fe9..566b8cf 100644 --- a/build.gradle +++ b/build.gradle @@ -49,7 +49,7 @@ java { group = 'com.pipedream' -version = '1.1.12' +version = '1.1.13' jar { dependsOn(":generatePomFileForMavenPublication") @@ -80,7 +80,7 @@ publishing { maven(MavenPublication) { groupId = 'com.pipedream' artifactId = 'pipedream' - version = '1.1.12' + version = '1.1.13' from components.java pom { name = 'pipedream' diff --git a/reference.md b/reference.md index 42da24f..5600d6c 100644 --- a/reference.md +++ b/reference.md @@ -1,9 +1,23 @@ # Reference ## AppCategories -
client.appCategories.list() -> List<AppCategory> +
client.appCategories.list() -> List&lt;AppCategory&gt;
+#### 📝 Description + +
+
+ +
+
+ +Retrieve all available categories for integrated apps +
+
+
+
+ #### 🔌 Usage
@@ -29,6 +43,20 @@ client.appCategories().list();
+#### 📝 Description + +
+
+ +
+
+ +Get details of a specific app category by its ID +
+
+
+
+ #### 🔌 Usage
@@ -66,10 +94,24 @@ client.appCategories().retrieve("id");
## Apps -
client.apps.list() -> ListAppsResponse +
client.apps.list() -> SyncPagingIterable&lt;App&gt;
+#### 📝 Description + +
+
+ +
+
+ +Retrieve all available apps with optional filtering and sorting +
+
+
+
+ #### 🔌 Usage
@@ -82,6 +124,15 @@ client.appCategories().retrieve("id"); client.apps().list( AppsListRequest .builder() + .after("after") + .before("before") + .limit(1) + .q("q") + .sortKey(AppsListRequestSortKey.NAME) + .sortDirection(AppsListRequestSortDirection.ASC) + .hasComponents(true) + .hasActions(true) + .hasTriggers(true) .build() ); ``` @@ -148,6 +199,30 @@ client.apps().list( **categoryIds:** `Optional` — Only return apps in these categories +
+
+ +
+
+ +**hasComponents:** `Optional` — Only return apps that have components (actions or triggers) + +
+
+ +
+
+ +**hasActions:** `Optional` — Only return apps that have actions + +
+
+ +
+
+ +**hasTriggers:** `Optional` — Only return apps that have triggers +
@@ -162,6 +237,20 @@ client.apps().list(
+#### 📝 Description + +
+
+ +
+
+ +Get detailed information about a specific app by ID or name slug +
+
+
+
+ #### 🔌 Usage
@@ -199,10 +288,24 @@ client.apps().retrieve("app_id");
## Accounts -
client.accounts.list(projectId) -> ListAccountsResponse +
client.accounts.list(projectId) -> SyncPagingIterable&lt;Account&gt; +
+
+ +#### 📝 Description + +
+
+
+Retrieve all connected accounts for the project with optional filtering +
+
+
+
+ #### 🔌 Usage
@@ -213,9 +316,15 @@ client.apps().retrieve("app_id"); ```java client.accounts().list( - "project_id", AccountsListRequest .builder() + .externalUserId("external_user_id") + .oauthAppId("oauth_app_id") + .after("after") + .before("before") + .limit(1) + .app("app") + .includeCredentials(true) .build() ); ``` @@ -232,7 +341,7 @@ client.accounts().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -240,7 +349,7 @@ client.accounts().list(
-**appId:** `Optional` — The app slug or ID to filter accounts by. +**externalUserId:** `Optional`
@@ -248,7 +357,7 @@ client.accounts().list(
-**externalUserId:** `Optional` +**oauthAppId:** `Optional` — The OAuth app ID to filter by, if applicable
@@ -256,7 +365,7 @@ client.accounts().list(
-**oauthAppId:** `Optional` — The OAuth app ID to filter by, if applicable +**after:** `Optional` — The cursor to start from for pagination
@@ -264,7 +373,7 @@ client.accounts().list(
-**after:** `Optional` — The cursor to start from for pagination +**before:** `Optional` — The cursor to end before for pagination
@@ -272,7 +381,7 @@ client.accounts().list(
-**before:** `Optional` — The cursor to end before for pagination +**limit:** `Optional` — The maximum number of results to return
@@ -280,7 +389,7 @@ client.accounts().list(
-**limit:** `Optional` — The maximum number of results to return +**app:** `Optional` — The app slug or ID to filter accounts by.
@@ -304,6 +413,20 @@ client.accounts().list(
+#### 📝 Description + +
+
+ +
+
+ +Connect a new account for an external user in the project +
+
+
+
+ #### 🔌 Usage
@@ -314,12 +437,13 @@ client.accounts().list( ```java client.accounts().create( - "project_id", CreateAccountOpts .builder() .appSlug("app_slug") .cfmapJson("cfmap_json") .connectToken("connect_token") + .externalUserId("external_user_id") + .oauthAppId("oauth_app_id") .build() ); ``` @@ -336,15 +460,7 @@ client.accounts().create(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - -
-
- -
-
- -**appId:** `Optional` — The app slug or ID to filter accounts by. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -408,6 +524,20 @@ client.accounts().create(
+#### 📝 Description + +
+
+ +
+
+ +Get the details for a specific connected account +
+
+
+
+ #### 🔌 Usage
@@ -418,10 +548,10 @@ client.accounts().create( ```java client.accounts().retrieve( - "project_id", "account_id", AccountsRetrieveRequest .builder() + .includeCredentials(true) .build() ); ``` @@ -438,7 +568,7 @@ client.accounts().retrieve(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -470,6 +600,20 @@ client.accounts().retrieve(
+#### 📝 Description + +
+
+ +
+
+ +Remove a connected account and its associated credentials +
+
+
+
+ #### 🔌 Usage
@@ -479,7 +623,7 @@ client.accounts().retrieve(
```java -client.accounts().delete("project_id", "account_id"); +client.accounts().delete("account_id"); ```
@@ -494,7 +638,7 @@ client.accounts().delete("project_id", "account_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -518,6 +662,20 @@ client.accounts().delete("project_id", "account_id");
+#### 📝 Description + +
+
+ +
+
+ +Remove all connected accounts for a specific app +
+
+
+
+ #### 🔌 Usage
@@ -527,7 +685,7 @@ client.accounts().delete("project_id", "account_id");
```java -client.accounts().deleteByApp("project_id", "app_id"); +client.accounts().deleteByApp("app_id"); ```
@@ -542,7 +700,7 @@ client.accounts().deleteByApp("project_id", "app_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -567,6 +725,20 @@ client.accounts().deleteByApp("project_id", "app_id");
+#### 📝 Description + +
+
+ +
+
+ +Remove an external user and all their associated accounts and resources +
+
+
+
+ #### 🔌 Usage
@@ -576,7 +748,7 @@ client.accounts().deleteByApp("project_id", "app_id");
```java -client.users().deleteExternalUser("project_id", "external_user_id"); +client.users().deleteExternalUser("external_user_id"); ```
@@ -591,7 +763,7 @@ client.users().deleteExternalUser("project_id", "external_user_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -611,11 +783,24 @@ client.users().deleteExternalUser("project_id", "external_user_id");
-## Components -
client.components.list(projectId) -> GetComponentsResponse +
client.users.list(projectId) -> SyncPagingIterable&lt;ExternalUser&gt; +
+
+ +#### 📝 Description +
+
+
+ +Retrieve all external users for the project +
+
+
+
+ #### 🔌 Usage
@@ -625,10 +810,13 @@ client.users().deleteExternalUser("project_id", "external_user_id");
```java -client.components().list( - "project_id", - ComponentsListRequest +client.users().list( + UsersListRequest .builder() + .after("after") + .before("before") + .limit(1) + .q("q") .build() ); ``` @@ -645,7 +833,7 @@ client.components().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -677,15 +865,7 @@ client.components().list(
-**q:** `Optional` — A search query to filter the components - -
-
- -
-
- -**app:** `Optional` — The ID or name slug of the app to filter the components +**q:** `Optional` — Filter users by external_id (partial match)
@@ -697,10 +877,25 @@ client.components().list(
-
client.components.retrieve(projectId, componentId) -> GetComponentResponse +## Components +
client.components.list(projectId) -> SyncPagingIterable&lt;Component&gt; +
+
+ +#### 📝 Description + +
+
+
+Retrieve available components with optional search and app filtering +
+
+
+
+ #### 🔌 Usage
@@ -710,7 +905,18 @@ client.components().list(
```java -client.components().retrieve("project_id", "component_id"); +client.components().list( + ComponentsListRequest + .builder() + .after("after") + .before("before") + .limit(1) + .q("q") + .app("app") + .registry(ComponentsListRequestRegistry.PUBLIC) + .componentType(ComponentType.TRIGGER) + .build() +); ```
@@ -725,7 +931,7 @@ client.components().retrieve("project_id", "component_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -733,60 +939,39 @@ client.components().retrieve("project_id", "component_id");
-**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') +**after:** `Optional` — The cursor to start from for pagination
-
-
+
+
+**before:** `Optional` — The cursor to end before for pagination +
-
-
client.components.configureProp(projectId, request) -> ConfigurePropResponse
-#### 🔌 Usage - -
-
+**limit:** `Optional` — The maximum number of results to return + +
+
-```java -client.components().configureProp( - "project_id", - ComponentsConfigurePropRequest - .builder() - .body( - ConfigurePropOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .propName("prop_name") - .build() - ) - .build() -); -``` -
-
+**q:** `Optional` — A search query to filter the components +
-#### ⚙️ Parameters -
-
-
- -**projectId:** `String` — The project ID, which starts with 'proj_'. +**app:** `Optional` — The ID or name slug of the app to filter the components
@@ -794,7 +979,7 @@ client.components().configureProp(
-**asyncHandle:** `Optional` +**registry:** `Optional` — The registry to retrieve components from. Defaults to 'all' ('public', 'private', or 'all')
@@ -802,7 +987,7 @@ client.components().configureProp(
-**request:** `ConfigurePropOpts` +**componentType:** `Optional` — The type of the component to filter the components
@@ -814,11 +999,11 @@ client.components().configureProp(
-
client.components.reloadProps(projectId, request) -> ReloadPropsResponse +
client.components.retrieve(projectId, componentId) -> GetComponentResponse
-#### 🔌 Usage +#### 📝 Description
@@ -826,20 +1011,28 @@ client.components().configureProp(
-```java -client.components().reloadProps( - "project_id", - ComponentsReloadPropsRequest - .builder() - .body( - ReloadPropsOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .build() - ) - .build() -); +Get detailed configuration for a specific component by its key +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.components().retrieve( + "component_id", + ComponentsRetrieveRequest + .builder() + .version("1.2.3") + .build() +); ```
@@ -854,7 +1047,7 @@ client.components().reloadProps(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -862,7 +1055,7 @@ client.components().reloadProps(
-**asyncHandle:** `Optional` +**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message')
@@ -870,7 +1063,7 @@ client.components().reloadProps(
-**request:** `ReloadPropsOpts` +**version:** `Optional` — Optional semantic version of the component to retrieve (for example '1.0.0')
@@ -882,11 +1075,24 @@ client.components().reloadProps(
-## Actions -
client.actions.list(projectId) -> GetComponentsResponse +
client.components.configureProp(projectId, request) -> ConfigurePropResponse +
+
+ +#### 📝 Description + +
+
+
+Retrieve remote options for a given prop for a component +
+
+
+
+ #### 🔌 Usage
@@ -896,10 +1102,12 @@ client.components().reloadProps(
```java -client.actions().list( - "project_id", - ActionsListRequest +client.components().configureProp( + ConfigurePropOpts .builder() + .id("id") + .externalUserId("external_user_id") + .propName("prop_name") .build() ); ``` @@ -916,7 +1124,7 @@ client.actions().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -924,54 +1132,36 @@ client.actions().list(
-**after:** `Optional` — The cursor to start from for pagination +**request:** `ConfigurePropOpts`
+
+
-
-
-**before:** `Optional` — The cursor to end before for pagination -
+
+
client.components.reloadProps(projectId, request) -> ReloadPropsResponse
-**limit:** `Optional` — The maximum number of results to return - -
-
+#### 📝 Description
-**q:** `Optional` — A search query to filter the actions - -
-
-
-**app:** `Optional` — The ID or name slug of the app to filter the actions - +Reload the prop definition based on the currently configured props
- - - -
- -
client.actions.retrieve(projectId, componentId) -> GetComponentResponse -
-
- #### 🔌 Usage
@@ -981,7 +1171,13 @@ client.actions().list(
```java -client.actions().retrieve("project_id", "component_id"); +client.components().reloadProps( + ReloadPropsOpts + .builder() + .id("id") + .externalUserId("external_user_id") + .build() +); ```
@@ -996,7 +1192,7 @@ client.actions().retrieve("project_id", "component_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1004,7 +1200,7 @@ client.actions().retrieve("project_id", "component_id");
-**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') +**request:** `ReloadPropsOpts`
@@ -1016,10 +1212,25 @@ client.actions().retrieve("project_id", "component_id");
-
client.actions.configureProp(projectId, request) -> ConfigurePropResponse +## Actions +
client.actions.list(projectId) -> SyncPagingIterable&lt;Component&gt; +
+
+ +#### 📝 Description + +
+
+
+Retrieve available actions with optional search and app filtering +
+
+
+
+ #### 🔌 Usage
@@ -1029,18 +1240,15 @@ client.actions().retrieve("project_id", "component_id");
```java -client.actions().configureProp( - "project_id", - ActionsConfigurePropRequest +client.actions().list( + ActionsListRequest .builder() - .body( - ConfigurePropOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .propName("prop_name") - .build() - ) + .after("after") + .before("before") + .limit(1) + .q("q") + .app("app") + .registry(ActionsListRequestRegistry.PUBLIC) .build() ); ``` @@ -1057,7 +1265,7 @@ client.actions().configureProp(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1065,7 +1273,7 @@ client.actions().configureProp(
-**asyncHandle:** `Optional` +**after:** `Optional` — The cursor to start from for pagination
@@ -1073,59 +1281,23 @@ client.actions().configureProp(
-**request:** `ConfigurePropOpts` +**before:** `Optional` — The cursor to end before for pagination
-
-
- - -
-
-
- -
client.actions.reloadProps(projectId, request) -> ReloadPropsResponse -
-
- -#### 🔌 Usage - -
-
-```java -client.actions().reloadProps( - "project_id", - ActionsReloadPropsRequest - .builder() - .body( - ReloadPropsOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .build() - ) - .build() -); -``` -
-
+**limit:** `Optional` — The maximum number of results to return +
-#### ⚙️ Parameters - -
-
-
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**q:** `Optional` — A search query to filter the actions
@@ -1133,7 +1305,7 @@ client.actions().reloadProps(
-**asyncHandle:** `Optional` +**app:** `Optional` — The ID or name slug of the app to filter the actions
@@ -1141,7 +1313,7 @@ client.actions().reloadProps(
-**request:** `ReloadPropsOpts` +**registry:** `Optional` — The registry to retrieve actions from. Defaults to 'all' ('public', 'private', or 'all')
@@ -1153,10 +1325,24 @@ client.actions().reloadProps(
-
client.actions.run(projectId, request) -> RunActionResponse +
client.actions.retrieve(projectId, componentId) -> GetComponentResponse +
+
+ +#### 📝 Description + +
+
+
+Get detailed configuration for a specific action by its key +
+
+
+
+ #### 🔌 Usage
@@ -1166,12 +1352,11 @@ client.actions().reloadProps(
```java -client.actions().run( - "project_id", - RunActionOpts +client.actions().retrieve( + "component_id", + ActionsRetrieveRequest .builder() - .id("id") - .externalUserId("external_user_id") + .version("1.2.3") .build() ); ``` @@ -1188,7 +1373,7 @@ client.actions().run(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1196,7 +1381,7 @@ client.actions().run(
-**asyncHandle:** `Optional` +**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message')
@@ -1204,46 +1389,35 @@ client.actions().run(
-**id:** `String` — The action component ID +**version:** `Optional` — Optional semantic version of the component to retrieve (for example '1.0.0')
+
+
-
-
-**externalUserId:** `String` — The external user ID -
+
+
client.actions.configureProp(projectId, request) -> ConfigurePropResponse
-**configuredProps:** `Optional>` — The configured properties for the action - -
-
+#### 📝 Description
-**dynamicPropsId:** `Optional` — The ID for dynamic props - -
-
+
+
+ +Retrieve remote options for a given prop for a action
- - -
- -## Triggers -
client.triggers.list(projectId) -> GetComponentsResponse -
-
#### 🔌 Usage @@ -1254,10 +1428,12 @@ client.actions().run(
```java -client.triggers().list( - "project_id", - TriggersListRequest +client.actions().configureProp( + ConfigurePropOpts .builder() + .id("id") + .externalUserId("external_user_id") + .propName("prop_name") .build() ); ``` @@ -1274,7 +1450,7 @@ client.triggers().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1282,53 +1458,35 @@ client.triggers().list(
-**after:** `Optional` — The cursor to start from for pagination +**request:** `ConfigurePropOpts`
+
+
-
-
-**before:** `Optional` — The cursor to end before for pagination -
+
+
client.actions.reloadProps(projectId, request) -> ReloadPropsResponse
-**limit:** `Optional` — The maximum number of results to return - -
-
+#### 📝 Description
-**q:** `Optional` — A search query to filter the triggers - -
-
-
-**app:** `Optional` — The ID or name slug of the app to filter the triggers - -
-
+Reload the prop definition based on the currently configured props - - -
- -
client.triggers.retrieve(projectId, componentId) -> GetComponentResponse -
-
#### 🔌 Usage @@ -1339,7 +1497,13 @@ client.triggers().list(
```java -client.triggers().retrieve("project_id", "component_id"); +client.actions().reloadProps( + ReloadPropsOpts + .builder() + .id("id") + .externalUserId("external_user_id") + .build() +); ```
@@ -1354,7 +1518,7 @@ client.triggers().retrieve("project_id", "component_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1362,7 +1526,7 @@ client.triggers().retrieve("project_id", "component_id");
-**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') +**request:** `ReloadPropsOpts`
@@ -1374,10 +1538,24 @@ client.triggers().retrieve("project_id", "component_id");
-
client.triggers.configureProp(projectId, request) -> ConfigurePropResponse +
client.actions.run(projectId, request) -> RunActionResponse +
+
+ +#### 📝 Description + +
+
+
+Execute an action with the provided configuration and return results +
+
+
+
+ #### 🔌 Usage
@@ -1387,18 +1565,11 @@ client.triggers().retrieve("project_id", "component_id");
```java -client.triggers().configureProp( - "project_id", - TriggersConfigurePropRequest +client.actions().run( + RunActionOpts .builder() - .body( - ConfigurePropOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .propName("prop_name") - .build() - ) + .id("id") + .externalUserId("external_user_id") .build() ); ``` @@ -1415,7 +1586,7 @@ client.triggers().configureProp(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1423,7 +1594,7 @@ client.triggers().configureProp(
-**asyncHandle:** `Optional` +**id:** `String` — The action component ID
@@ -1431,22 +1602,1215 @@ client.triggers().configureProp(
-**request:** `ConfigurePropOpts` +**version:** `Optional` — Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest
-
-
+
+
-
+**externalUserId:** `String` — The external user ID + +
+
+ +
+
+ +**configuredProps:** `Optional>` + +
+
+ +
+
+ +**dynamicPropsId:** `Optional` — The ID for dynamic props + +
+
+ +
+
+ +**stashId:** `Optional` + +
+
+ + + + + + +
+ +## Triggers +
client.triggers.list(projectId) -> SyncPagingIterable&lt;Component&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve available triggers with optional search and app filtering +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +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` — The cursor to start from for pagination + +
+
+ +
+
+ +**before:** `Optional` — The cursor to end before for pagination + +
+
+ +
+
+ +**limit:** `Optional` — The maximum number of results to return + +
+
+ +
+
+ +**q:** `Optional` — A search query to filter the triggers + +
+
+ +
+
+ +**app:** `Optional` — The ID or name slug of the app to filter the triggers + +
+
+ +
+
+ +**registry:** `Optional` — 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 + +
+
+ +
+
+ +```java +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` — 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 + +
+
+ +
+
+ +```java +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 + +
+
+ +
+
+ +```java +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 + +
+
+ +
+
+ +```java +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` — Optional trigger component version (in SemVer format, for example '1.0.0'), defaults to latest + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID + +
+
+ +
+
+ +**configuredProps:** `Optional>` + +
+
+ +
+
+ +**dynamicPropsId:** `Optional` — The ID for dynamic props + +
+
+ +
+
+ +**workflowId:** `Optional` — Optional ID of a workflow to receive trigger events + +
+
+ +
+
+ +**webhookUrl:** `Optional` — Optional webhook URL to receive trigger events + +
+
+ +
+
+ +**emitOnDeploy:** `Optional` — 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 + +
+
+ +
+
+ +```java +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` — The cursor to start from for pagination + +
+
+ +
+
+ +**before:** `Optional` — The cursor to end before for pagination + +
+
+ +
+
+ +**limit:** `Optional` — The maximum number of results to return + +
+
+ +
+
+ +**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger + +
+
+ +
+
+ +**emitterType:** `Optional` — 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 + +
+
+ +
+
+ +```java +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 + +
+
+ +
+
+ +```java +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` — Whether the trigger should be active + +
+
+ +
+
+ +**configuredProps:** `Optional>` + +
+
+ +
+
+ +**name:** `Optional` — The name of the trigger + +
+
+ +
+
+ +**emitOnDeploy:** `Optional` — Whether the trigger should emit events during deployment + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.delete(projectId, triggerId) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Remove a deployed trigger and stop receiving events +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +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` — Whether to ignore errors during deactivation hook + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.listEvents(projectId, triggerId) -> GetTriggerEventsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve recent events emitted by a deployed trigger +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +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` — 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 + +
+
+ +
+
+ +```java +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 + +
+
+ +
+
+ +```java +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` — Array of workflow IDs to set + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.listWebhooks(projectId, triggerId) -> GetTriggerWebhooksResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get webhook URLs configured to receive trigger events +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +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.triggers.reloadProps(projectId, request) -> ReloadPropsResponse +
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
@@ -1456,16 +2820,13 @@ client.triggers().configureProp(
```java -client.triggers().reloadProps( - "project_id", - TriggersReloadPropsRequest +client.deployedTriggers().updateWebhooks( + "trigger_id", + UpdateTriggerWebhooksOpts .builder() - .body( - ReloadPropsOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .build() + .externalUserId("external_user_id") + .webhookUrls( + Arrays.asList("webhook_urls") ) .build() ); @@ -1483,7 +2844,7 @@ client.triggers().reloadProps(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1491,7 +2852,7 @@ client.triggers().reloadProps(
-**asyncHandle:** `Optional` +**triggerId:** `String`
@@ -1499,7 +2860,15 @@ client.triggers().reloadProps(
-**request:** `ReloadPropsOpts` +**externalUserId:** `String` — The external user ID who owns the trigger + +
+
+ +
+
+ +**webhookUrls:** `List` — Array of webhook URLs to set
@@ -1511,10 +2880,24 @@ client.triggers().reloadProps(
-
client.triggers.deploy(projectId, request) -> DeployTriggerResponse +
client.deployedTriggers.retrieveWebhook(projectId, triggerId, webhookId) -> GetWebhookWithSigningKeyResponse +
+
+ +#### 📝 Description + +
+
+
+Retrieve a specific webhook for a deployed trigger, including its signing key +
+
+
+
+ #### 🔌 Usage
@@ -1524,11 +2907,11 @@ client.triggers().reloadProps(
```java -client.triggers().deploy( - "project_id", - DeployTriggerOpts +client.deployedTriggers().retrieveWebhook( + "trigger_id", + "webhook_id", + DeployedTriggersRetrieveWebhookRequest .builder() - .id("id") .externalUserId("external_user_id") .build() ); @@ -1546,7 +2929,7 @@ client.triggers().deploy(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1554,7 +2937,7 @@ client.triggers().deploy(
-**id:** `String` — The trigger component ID +**triggerId:** `String`
@@ -1562,7 +2945,7 @@ client.triggers().deploy(
-**externalUserId:** `String` — The external user ID +**webhookId:** `String`
@@ -1570,15 +2953,68 @@ client.triggers().deploy(
-**configuredProps:** `Optional>` — The configured properties for the trigger +**externalUserId:** `String` — The external user ID who owns the trigger
+
+
+ + +
+
+
+
client.deployedTriggers.regenerateWebhookSigningKey(projectId, triggerId, webhookId) -> GetWebhookWithSigningKeyResponse
-**dynamicPropsId:** `Optional` — The ID for dynamic props +#### 📝 Description + +
+
+ +
+
+ +Regenerate the signing key for a specific webhook on a deployed trigger +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().regenerateWebhookSigningKey( + "trigger_id", + "webhook_id", + DeployedTriggersRegenerateWebhookSigningKeyRequest + .builder() + .externalUserId("external_user_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1586,7 +3022,23 @@ client.triggers().deploy(
-**webhookUrl:** `Optional` — Optional webhook URL to receive trigger events +**triggerId:** `String` + +
+
+ +
+
+ +**webhookId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID who owns the trigger
@@ -1598,11 +3050,25 @@ client.triggers().deploy(
-## DeployedTriggers -
client.deployedTriggers.list(projectId) -> GetTriggersResponse +## ProjectEnvironment +
client.projectEnvironment.retrieveWebhook(projectId) -> GetWebhookResponse +
+
+ +#### 📝 Description + +
+
+
+Retrieve the webhook configured for a project environment +
+
+
+
+ #### 🔌 Usage
@@ -1612,11 +3078,64 @@ client.triggers().deploy(
```java -client.deployedTriggers().list( - "project_id", - DeployedTriggersListRequest +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 + +
+
+ +
+
+ +```java +client.projectEnvironment().updateWebhook( + SetWebhookOpts .builder() - .externalUserId("external_user_id") + .url("url") .build() ); ``` @@ -1633,7 +3152,7 @@ client.deployedTriggers().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1641,31 +3160,61 @@ client.deployedTriggers().list(
-**after:** `Optional` — The cursor to start from for pagination +**url:** `String` — The webhook URL to set
+
+
+ + +
+
+
+ +
client.projectEnvironment.deleteWebhook(projectId) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Remove the webhook configured for a project environment +
+
+
+
+ +#### 🔌 Usage
-**before:** `Optional` — The cursor to end before for pagination - -
-
-
-**limit:** `Optional` — The maximum number of results to return - +```java +client.projectEnvironment().deleteWebhook(); +``` +
+
+#### ⚙️ Parameters +
-**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1677,11 +3226,11 @@ client.deployedTriggers().list(
-
client.deployedTriggers.retrieve(projectId, triggerId) -> GetTriggerResponse +
client.projectEnvironment.regenerateWebhookSigningKey(projectId) -> GetWebhookWithSigningKeyResponse
-#### 🔌 Usage +#### 📝 Description
@@ -1689,22 +3238,13 @@ client.deployedTriggers().list(
-```java -client.deployedTriggers().retrieve( - "project_id", - "trigger_id", - DeployedTriggersRetrieveRequest - .builder() - .externalUserId("external_user_id") - .build() -); -``` +Regenerate the signing key for the project environment webhook
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -1712,23 +3252,23 @@ client.deployedTriggers().retrieve(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +```java +client.projectEnvironment().regenerateWebhookSigningKey(); +``` +
+
+#### ⚙️ Parameters +
-**triggerId:** `String` - -
-
-
-**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1740,11 +3280,12 @@ client.deployedTriggers().retrieve(
-
client.deployedTriggers.update(projectId, triggerId, request) -> GetTriggerResponse +## Projects +
client.projects.list() -> SyncPagingIterable&lt;Project&gt;
-#### 🔌 Usage +#### 📝 Description
@@ -1752,22 +3293,13 @@ client.deployedTriggers().retrieve(
-```java -client.deployedTriggers().update( - "project_id", - "trigger_id", - UpdateTriggerOpts - .builder() - .externalUserId("external_user_id") - .build() -); -``` +List the projects that are available to the authenticated Connect client
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -1775,23 +3307,31 @@ client.deployedTriggers().update(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +```java +client.projects().list( + ProjectsListRequest + .builder() + .after("after") + .before("before") + .limit(1) + .q("q") + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**triggerId:** `String` - -
-
-
-**externalUserId:** `String` — The external user ID who owns the trigger +**after:** `Optional` — The cursor to start from for pagination
@@ -1799,7 +3339,7 @@ client.deployedTriggers().update(
-**active:** `Optional` — Whether the trigger should be active +**before:** `Optional` — The cursor to end before for pagination
@@ -1807,7 +3347,7 @@ client.deployedTriggers().update(
-**configuredProps:** `Optional>` — The configured properties for the trigger +**limit:** `Optional` — The maximum number of results to return
@@ -1815,7 +3355,7 @@ client.deployedTriggers().update(
-**name:** `Optional` — The name of the trigger +**q:** `Optional` — A search query to filter the projects
@@ -1827,10 +3367,24 @@ client.deployedTriggers().update(
-
client.deployedTriggers.delete(projectId, triggerId) +
client.projects.create(request) -> Project +
+
+ +#### 📝 Description + +
+
+
+Create a new project for the authenticated workspace +
+
+
+
+ #### 🔌 Usage
@@ -1840,12 +3394,10 @@ client.deployedTriggers().update(
```java -client.deployedTriggers().delete( - "project_id", - "trigger_id", - DeployedTriggersDeleteRequest +client.projects().create( + CreateProjectOpts .builder() - .externalUserId("external_user_id") + .name("name") .build() ); ``` @@ -1862,7 +3414,7 @@ client.deployedTriggers().delete(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**name:** `String` — Name of the project
@@ -1870,7 +3422,7 @@ client.deployedTriggers().delete(
-**triggerId:** `String` +**appName:** `Optional` — Display name for the Connect application
@@ -1878,7 +3430,7 @@ client.deployedTriggers().delete(
-**externalUserId:** `String` — The external user ID who owns the trigger +**supportEmail:** `Optional` — Support email displayed to end users
@@ -1886,7 +3438,7 @@ client.deployedTriggers().delete(
-**ignoreHookErrors:** `Optional` — Whether to ignore errors during deactivation hook +**connectRequireKeyAuthTest:** `Optional` — Send a test request to the upstream API when adding Connect accounts for key-based apps
@@ -1898,11 +3450,11 @@ client.deployedTriggers().delete(
-
client.deployedTriggers.listEvents(projectId, triggerId) -> GetTriggerEventsResponse +
client.projects.retrieve(projectId) -> Project
-#### 🔌 Usage +#### 📝 Description
@@ -1910,22 +3462,13 @@ client.deployedTriggers().delete(
-```java -client.deployedTriggers().listEvents( - "project_id", - "trigger_id", - DeployedTriggersListEventsRequest - .builder() - .externalUserId("external_user_id") - .build() -); -``` +Get the project details for a specific project
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -1933,31 +3476,23 @@ client.deployedTriggers().listEvents(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +```java +client.projects().retrieve("project_id"); +```
- -
-
- -**triggerId:** `String` -
+#### ⚙️ Parameters +
-**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger - -
-
-
-**n:** `Optional` — The number of events to retrieve (defaults to 20 if not provided) +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -1969,11 +3504,11 @@ client.deployedTriggers().listEvents(
-
client.deployedTriggers.listWorkflows(projectId, triggerId) -> GetTriggerWorkflowsResponse +
client.projects.delete(projectId)
-#### 🔌 Usage +#### 📝 Description
@@ -1981,22 +3516,13 @@ client.deployedTriggers().listEvents(
-```java -client.deployedTriggers().listWorkflows( - "project_id", - "trigger_id", - DeployedTriggersListWorkflowsRequest - .builder() - .externalUserId("external_user_id") - .build() -); -``` +Delete a project owned by the authenticated workspace
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -2004,23 +3530,23 @@ client.deployedTriggers().listWorkflows(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +```java +client.projects().delete("project_id"); +``` +
+
+#### ⚙️ Parameters +
-**triggerId:** `String` - -
-
-
-**externalUserId:** `String` — The external user ID who owns the trigger +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -2032,10 +3558,24 @@ client.deployedTriggers().listWorkflows(
-
client.deployedTriggers.updateWorkflows(projectId, triggerId, request) -> GetTriggerWorkflowsResponse +
client.projects.update(projectId, request) -> Project
+#### 📝 Description + +
+
+ +
+
+ +Update project details or application information +
+
+
+
+ #### 🔌 Usage
@@ -2045,17 +3585,10 @@ client.deployedTriggers().listWorkflows(
```java -client.deployedTriggers().updateWorkflows( +client.projects().update( "project_id", - "trigger_id", - UpdateTriggerWorkflowsOpts + UpdateProjectOpts .builder() - .externalUserId("external_user_id") - .workflowIds( - new ArrayList( - Arrays.asList("workflow_ids") - ) - ) .build() ); ``` @@ -2072,7 +3605,7 @@ client.deployedTriggers().updateWorkflows(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -2080,7 +3613,7 @@ client.deployedTriggers().updateWorkflows(
-**triggerId:** `String` +**name:** `Optional` — Name of the project
@@ -2088,7 +3621,7 @@ client.deployedTriggers().updateWorkflows(
-**externalUserId:** `String` — The external user ID who owns the trigger +**appName:** `Optional` — Display name for the Connect application
@@ -2096,7 +3629,15 @@ client.deployedTriggers().updateWorkflows(
-**workflowIds:** `List` — Array of workflow IDs to set +**supportEmail:** `Optional` — Support email displayed to end users + +
+
+ +
+
+ +**connectRequireKeyAuthTest:** `Optional` — Send a test request to the upstream API when adding Connect accounts for key-based apps
@@ -2108,10 +3649,24 @@ client.deployedTriggers().updateWorkflows(
-
client.deployedTriggers.listWebhooks(projectId, triggerId) -> GetTriggerWebhooksResponse +
client.projects.updateLogo(projectId, request) +
+
+ +#### 📝 Description + +
+
+
+Upload or replace the project logo +
+
+
+
+ #### 🔌 Usage
@@ -2121,12 +3676,11 @@ client.deployedTriggers().updateWorkflows(
```java -client.deployedTriggers().listWebhooks( +client.projects().updateLogo( "project_id", - "trigger_id", - DeployedTriggersListWebhooksRequest + UpdateProjectLogoOpts .builder() - .externalUserId("external_user_id") + .logo("data:image/png;base64,AAAAAA...") .build() ); ``` @@ -2143,15 +3697,7 @@ client.deployedTriggers().listWebhooks(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - -
-
- -
-
- -**triggerId:** `String` +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -2159,7 +3705,7 @@ client.deployedTriggers().listWebhooks(
-**externalUserId:** `String` — The external user ID who owns the trigger +**logo:** `String` — Data URI containing the new Base64 encoded image
@@ -2171,10 +3717,24 @@ client.deployedTriggers().listWebhooks(
-
client.deployedTriggers.updateWebhooks(projectId, triggerId, request) -> GetTriggerWebhooksResponse +
client.projects.retrieveInfo(projectId) -> ProjectInfoResponse
+#### 📝 Description + +
+
+ +
+
+ +Retrieve project configuration and environment details +
+
+
+
+ #### 🔌 Usage
@@ -2184,19 +3744,7 @@ client.deployedTriggers().listWebhooks(
```java -client.deployedTriggers().updateWebhooks( - "project_id", - "trigger_id", - UpdateTriggerWebhooksOpts - .builder() - .externalUserId("external_user_id") - .webhookUrls( - new ArrayList( - Arrays.asList("webhook_urls") - ) - ) - .build() -); +client.projects().retrieveInfo(); ```
@@ -2211,46 +3759,36 @@ client.deployedTriggers().updateWebhooks(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
+
+
-
-
-**triggerId:** `String` -
+
+## FileStash +
client.fileStash.downloadFile(projectId) -> InputStream
-**externalUserId:** `String` — The external user ID who owns the trigger - -
-
+#### 📝 Description
-**webhookUrls:** `List` — Array of webhook URLs to set - -
-
- - - +
+
+Download a file from File Stash +
+
-
- -## Projects -
client.projects.retrieveInfo(projectId) -> ProjectInfoResponse -
-
#### 🔌 Usage @@ -2261,7 +3799,12 @@ client.deployedTriggers().updateWebhooks(
```java -client.projects().retrieveInfo("project_id"); +client.fileStash().downloadFile( + FileStashDownloadFileRequest + .builder() + .s3Key("s3_key") + .build() +); ```
@@ -2276,7 +3819,15 @@ client.projects().retrieveInfo("project_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**s3Key:** `String`
@@ -2289,10 +3840,24 @@ client.projects().retrieveInfo("project_id");
## Proxy -
client.proxy.get(url, request) -> Object +
client.proxy.get(projectId, url64) -> InputStream +
+
+ +#### 📝 Description +
+
+
+ +Forward an authenticated GET request to an external API using an external user's account credentials +
+
+
+
+ #### 🔌 Usage
@@ -2303,7 +3868,7 @@ client.projects().retrieveInfo("project_id"); ```java client.proxy().get( - "https://api.example.com/endpoint", + "url_64", ProxyGetRequest .builder() .externalUserId("external_user_id") @@ -2324,7 +3889,15 @@ client.proxy().get(
-**url:** `String` — The target URL to proxy the request to +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**url64:** `String` — Base64-encoded target URL
@@ -2347,22 +3920,29 @@ client.proxy().get(
-#### 📄 Response - -The proxy methods intelligently handle responses: -- **JSON responses**: Automatically parsed and returned as structured objects -- **Non-JSON responses**: Returned as raw strings (HTML, XML, plain text, etc.) -- **Empty responses**: Return `null` -
-
client.proxy.post(url, request) -> Object +
client.proxy.post(projectId, url64, request) -> InputStream +
+
+ +#### 📝 Description + +
+
+
+Forward an authenticated POST request to an external API using an external user's account credentials +
+
+
+
+ #### 🔌 Usage
@@ -2373,14 +3953,16 @@ The proxy methods intelligently handle responses: ```java client.proxy().post( - "https://api.example.com/endpoint", + "url_64", ProxyPostRequest .builder() .externalUserId("external_user_id") .accountId("account_id") .body( new HashMap() {{ - put("key", "value"); + put("string", new + HashMap() {{put("key", "value"); + }}); }} ) .build() @@ -2399,7 +3981,15 @@ client.proxy().post(
-**url:** `String` — The target URL to proxy the request to +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**url64:** `String` — Base64-encoded target URL
@@ -2435,10 +4025,24 @@ client.proxy().post(
-
client.proxy.put(url, request) -> Object +
client.proxy.put(projectId, url64, request) -> InputStream +
+
+ +#### 📝 Description +
+
+
+ +Forward an authenticated PUT request to an external API using an external user's account credentials +
+
+
+
+ #### 🔌 Usage
@@ -2449,14 +4053,16 @@ client.proxy().post( ```java client.proxy().put( - "https://api.example.com/endpoint", + "url_64", ProxyPutRequest .builder() .externalUserId("external_user_id") .accountId("account_id") .body( new HashMap() {{ - put("key", "value"); + put("string", new + HashMap() {{put("key", "value"); + }}); }} ) .build() @@ -2475,7 +4081,15 @@ client.proxy().put(
-**url:** `String` — The target URL to proxy the request to +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**url64:** `String` — Base64-encoded target URL
@@ -2511,10 +4125,24 @@ client.proxy().put(
-
client.proxy.delete(url, request) -> Object +
client.proxy.delete(projectId, url64) -> InputStream +
+
+ +#### 📝 Description + +
+
+
+Forward an authenticated DELETE request to an external API using an external user's account credentials +
+
+
+
+ #### 🔌 Usage
@@ -2525,7 +4153,7 @@ client.proxy().put( ```java client.proxy().delete( - "https://api.example.com/endpoint", + "url_64", ProxyDeleteRequest .builder() .externalUserId("external_user_id") @@ -2546,7 +4174,15 @@ client.proxy().delete(
-**url:** `String` — The target URL to proxy the request to +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**url64:** `String` — Base64-encoded target URL
@@ -2574,10 +4210,24 @@ client.proxy().delete(
-
client.proxy.patch(url, request) -> Object +
client.proxy.patch(projectId, url64, request) -> InputStream +
+
+ +#### 📝 Description + +
+
+
+Forward an authenticated PATCH request to an external API using an external user's account credentials +
+
+
+
+ #### 🔌 Usage
@@ -2588,14 +4238,16 @@ client.proxy().delete( ```java client.proxy().patch( - "https://api.example.com/endpoint", + "url_64", ProxyPatchRequest .builder() .externalUserId("external_user_id") .accountId("account_id") .body( new HashMap() {{ - put("key", "value"); + put("string", new + HashMap() {{put("key", "value"); + }}); }} ) .build() @@ -2614,7 +4266,15 @@ client.proxy().patch(
-**url:** `String` — The target URL to proxy the request to +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**url64:** `String` — Base64-encoded target URL
@@ -2655,6 +4315,20 @@ client.proxy().patch(
+#### 📝 Description + +
+
+ +
+
+ +Generate a Connect token to use for client-side authentication +
+
+
+
+ #### 🔌 Usage
@@ -2665,7 +4339,6 @@ client.proxy().patch( ```java client.tokens().create( - "project_id", CreateTokenOpts .builder() .externalUserId("external_user_id") @@ -2685,7 +4358,7 @@ client.tokens().create(
-**projectId:** `String` — The project ID, which starts with 'proj_'. +**projectId:** `String` — The project ID, which starts with `proj_`.
@@ -2709,7 +4382,7 @@ client.tokens().create(
-**externalUserId:** `String` — Your end user ID, for whom you're creating the token +**expiresIn:** `Optional` — Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.
@@ -2717,7 +4390,7 @@ client.tokens().create(
-**successRedirectUri:** `Optional` — URI to redirect to on success +**externalUserId:** `String` — Your end user ID, for whom you're creating the token
@@ -2725,84 +4398,51 @@ client.tokens().create(
-**webhookUri:** `Optional` — Webhook URI for notifications +**scope:** `Optional` — 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.
-
-
- -
-
-
- -
client.tokens.validate(projectId, ctok) -> ValidateTokenResponse
-#### 🔌 Usage - -
-
+**successRedirectUri:** `Optional` — URI to redirect to on success + +
+
-```java -client.tokens().validate( - "project_id", - "ctok", - TokensValidateRequest - .builder() - .build() -); -``` +**webhookUri:** `Optional` — Webhook URI for notifications +
-#### ⚙️ Parameters -
-
+
+
+
+
client.tokens.validate(ctok) -> ValidateTokenResponse
-**projectId:** `String` — The project ID, which starts with 'proj_'. - -
-
+#### 📝 Description
-**ctok:** `String` - -
-
-
-**params:** `Optional` - -
-
+Confirm the validity of a Connect token - - -
- -## Workflows -
client.workflows.invoke(urlOrEndpoint) -> Object -
-
#### 🔌 Usage @@ -2813,28 +4453,12 @@ client.tokens().validate(
```java -// Simple workflow invocation (uses OAuth authentication by default) -client.workflows().invoke("eo3xxxx"); - -// Advanced workflow invocation with all options -client.workflows().invoke( - InvokeWorkflowOpts +client.tokens().validate( + "ctok", + TokensValidateRequest .builder() - .urlOrEndpoint("https://eo3xxxx.m.pipedream.net") - .body( - new HashMap() {{ - put("name", "John Doe"); - put("email", "john@example.com"); - }} - ) - .headers( - new HashMap() {{ - put("Content-Type", "application/json"); - put("Authorization", "Bearer your-token"); // For STATIC_BEARER auth - }} - ) - .method("POST") - .authType(HTTPAuthType.STATIC_BEARER) + .appId("app_id") + .oauthAppId("oauth_app_id") .build() ); ``` @@ -2851,7 +4475,7 @@ client.workflows().invoke(
-**urlOrEndpoint:** `String` — Either a workflow endpoint ID (e.g., 'eo3xxxx') or a full workflow URL +**ctok:** `String`
@@ -2859,7 +4483,7 @@ client.workflows().invoke(
-**body:** `Optional` — Request body to send to the workflow (will be JSON serialized) +**appId:** `String` — The app ID to validate against @@ -2867,38 +4491,37 @@ client.workflows().invoke(
-**headers:** `Optional>` — Additional headers to include in the request +**oauthAppId:** `Optional` — The OAuth app ID to validate against (if the token is for an OAuth app)
+ + -
-
-**method:** `Optional` — HTTP method to use (defaults to 'POST') -
+ +## Usage +
client.usage.list() -> ConnectUsageResponse
-**authType:** `Optional` — Authentication type: OAUTH (default), STATIC_BEARER, or NONE - -
-
- - - +#### 📝 Description - - -
+
+
-
client.workflows.invokeForExternalUser(urlOrEndpoint, externalUserId) -> Object
+Retrieve Connect usage records for a time window +
+
+
+
+ #### 🔌 Usage
@@ -2908,28 +4531,11 @@ client.workflows().invoke(
```java -// 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 +client.usage().list( + UsageListRequest .builder() - .url("https://eo3xxxx.m.pipedream.net") - .externalUserId("user123") - .body( - new HashMap() {{ - put("action", "process_data"); - put("data", Arrays.asList("item1", "item2")); - }} - ) - .headers( - new HashMap() {{ - put("X-Custom-Header", "value"); - }} - ) - .method("POST") - .authType(HTTPAuthType.OAUTH) + .startTs(1) + .endTs(1) .build() ); ``` @@ -2946,7 +4552,7 @@ client.workflows().invokeForExternalUser(
-**url:** `String` — The full workflow URL to invoke +**startTs:** `Integer` — Usage window start timestamp (seconds)
@@ -2954,54 +4560,36 @@ client.workflows().invokeForExternalUser(
-**externalUserId:** `String` — The external user ID for Pipedream Connect authentication +**endTs:** `Integer` — Usage window end timestamp (seconds)
+
+
-
-
-**body:** `Optional` — Request body to send to the workflow (will be JSON serialized) - + +## OauthTokens +
client.oauthTokens.create(request) -> CreateOAuthTokenResponse
-**headers:** `Optional>` — Additional headers to include in the request - -
-
+#### 📝 Description
-**method:** `Optional` — HTTP method to use (defaults to 'POST') - -
-
-
-**authType:** `Optional` — Authentication type: OAUTH (default), STATIC_BEARER, or NONE - -
-
+Exchange OAuth credentials for an access token - - -
- -## OauthTokens -
client.oauthTokens.create(request) -> CreateOAuthTokenResponse -
-
#### 🔌 Usage @@ -3052,6 +4640,14 @@ client.oauthTokens().create( **clientSecret:** `String` +
+
+ +
+
+ +**scope:** `Optional` — Optional space-separated scopes for the access token. Defaults to `*`. +
diff --git a/src/main/java/com/pipedream/api/core/ClientOptions.java b/src/main/java/com/pipedream/api/core/ClientOptions.java index abda75d..f9585df 100644 --- a/src/main/java/com/pipedream/api/core/ClientOptions.java +++ b/src/main/java/com/pipedream/api/core/ClientOptions.java @@ -35,10 +35,10 @@ private ClientOptions( this.headers.putAll(headers); this.headers.putAll(new HashMap() { { - put("User-Agent", "com.pipedream:pipedream/1.1.12"); + put("User-Agent", "com.pipedream:pipedream/1.1.13"); put("X-Fern-Language", "JAVA"); put("X-Fern-SDK-Name", "com.pipedream.fern:api-sdk"); - put("X-Fern-SDK-Version", "1.1.12"); + put("X-Fern-SDK-Version", "1.1.13"); } }); this.headerSuppliers = headerSuppliers; From 03082983a378842c5227e6151d7448cf86e60126 Mon Sep 17 00:00:00 2001 From: Jay Vercellone Date: Mon, 27 Apr 2026 12:49:42 -0700 Subject: [PATCH 2/3] Undo version updates --- README.md | 4 ++-- build.gradle | 4 ++-- src/main/java/com/pipedream/api/core/ClientOptions.java | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cfa97c3..69021da 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Add the dependency in your `build.gradle` file: ```groovy dependencies { - implementation 'com.pipedream:pipedream:1.1.13' + implementation 'com.pipedream:pipedream:1.1.12' } ``` @@ -40,7 +40,7 @@ Add the dependency in your `pom.xml` file: com.pipedream pipedream - 1.1.13 + 1.1.12 ``` diff --git a/build.gradle b/build.gradle index 566b8cf..0a47fe9 100644 --- a/build.gradle +++ b/build.gradle @@ -49,7 +49,7 @@ java { group = 'com.pipedream' -version = '1.1.13' +version = '1.1.12' jar { dependsOn(":generatePomFileForMavenPublication") @@ -80,7 +80,7 @@ publishing { maven(MavenPublication) { groupId = 'com.pipedream' artifactId = 'pipedream' - version = '1.1.13' + version = '1.1.12' from components.java pom { name = 'pipedream' diff --git a/src/main/java/com/pipedream/api/core/ClientOptions.java b/src/main/java/com/pipedream/api/core/ClientOptions.java index f9585df..abda75d 100644 --- a/src/main/java/com/pipedream/api/core/ClientOptions.java +++ b/src/main/java/com/pipedream/api/core/ClientOptions.java @@ -35,10 +35,10 @@ private ClientOptions( this.headers.putAll(headers); this.headers.putAll(new HashMap() { { - put("User-Agent", "com.pipedream:pipedream/1.1.13"); + put("User-Agent", "com.pipedream:pipedream/1.1.12"); put("X-Fern-Language", "JAVA"); put("X-Fern-SDK-Name", "com.pipedream.fern:api-sdk"); - put("X-Fern-SDK-Version", "1.1.13"); + put("X-Fern-SDK-Version", "1.1.12"); } }); this.headerSuppliers = headerSuppliers; From b996e4359d406b6077c3a87ea207646c7a3aa70f Mon Sep 17 00:00:00 2001 From: Jay Vercellone Date: Mon, 27 Apr 2026 12:57:08 -0700 Subject: [PATCH 3/3] Restore reference doc stuff --- .fernignore | 2 +- reference.md | 694 +++++++++++++++++++++++++++++++++------------------ 2 files changed, 448 insertions(+), 248 deletions(-) diff --git a/.fernignore b/.fernignore index 04b4c10..a08c0c9 100644 --- a/.fernignore +++ b/.fernignore @@ -7,7 +7,7 @@ LICENSE # References doc (we have additional use cases) -# reference.md +reference.md # Base client files (temporary) src/main/java/com/pipedream/api/AsyncBaseClientBuilder.java diff --git a/reference.md b/reference.md index 5600d6c..04bcf5a 100644 --- a/reference.md +++ b/reference.md @@ -82,7 +82,7 @@ client.appCategories().retrieve("id");
**id:** `String` — The ID of the app category to retrieve - +
@@ -150,7 +150,7 @@ client.apps().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -158,7 +158,7 @@ client.apps().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -166,7 +166,7 @@ client.apps().list(
**limit:** `Optional` — The maximum number of results to return - +
@@ -174,7 +174,7 @@ client.apps().list(
**q:** `Optional` — A search query to filter the apps - +
@@ -182,7 +182,7 @@ client.apps().list(
**sortKey:** `Optional` — The key to sort the apps by - +
@@ -190,7 +190,7 @@ client.apps().list(
**sortDirection:** `Optional` — The direction to sort the apps - +
@@ -198,7 +198,7 @@ client.apps().list(
**categoryIds:** `Optional` — Only return apps in these categories - +
@@ -206,7 +206,7 @@ client.apps().list(
**hasComponents:** `Optional` — Only return apps that have components (actions or triggers) - +
@@ -214,7 +214,7 @@ client.apps().list(
**hasActions:** `Optional` — Only return apps that have actions - +
@@ -222,7 +222,7 @@ client.apps().list(
**hasTriggers:** `Optional` — Only return apps that have triggers - +
@@ -276,7 +276,7 @@ client.apps().retrieve("app_id");
**appId:** `String` — The name slug or ID of the app (e.g., 'slack', 'github') - +
@@ -342,15 +342,15 @@ client.accounts().list(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**externalUserId:** `Optional` - +**externalUserId:** `Optional` +
@@ -358,7 +358,7 @@ client.accounts().list(
**oauthAppId:** `Optional` — The OAuth app ID to filter by, if applicable - +
@@ -366,7 +366,7 @@ client.accounts().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -374,7 +374,7 @@ client.accounts().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -382,7 +382,7 @@ client.accounts().list(
**limit:** `Optional` — The maximum number of results to return - +
@@ -390,7 +390,7 @@ client.accounts().list(
**app:** `Optional` — The app slug or ID to filter accounts by. - +
@@ -398,7 +398,7 @@ client.accounts().list(
**includeCredentials:** `Optional` — Whether to retrieve the account's credentials or not - +
@@ -461,15 +461,15 @@ client.accounts().create(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**externalUserId:** `Optional` - +**externalUserId:** `Optional` +
@@ -477,7 +477,7 @@ client.accounts().create(
**oauthAppId:** `Optional` — The OAuth app ID to filter by, if applicable - +
@@ -485,7 +485,7 @@ client.accounts().create(
**appSlug:** `String` — The app slug for the account - +
@@ -493,7 +493,7 @@ client.accounts().create(
**cfmapJson:** `String` — JSON string containing the custom fields mapping - +
@@ -501,7 +501,7 @@ client.accounts().create(
**connectToken:** `String` — The connect token for authentication - +
@@ -509,7 +509,7 @@ client.accounts().create(
**name:** `Optional` — Optional name for the account - +
@@ -569,15 +569,15 @@ client.accounts().retrieve(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**accountId:** `String` - +**accountId:** `String` +
@@ -585,7 +585,7 @@ client.accounts().retrieve(
**includeCredentials:** `Optional` — Whether to retrieve the account's credentials or not - +
@@ -639,15 +639,15 @@ client.accounts().delete("account_id");
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**accountId:** `String` - +**accountId:** `String` +
@@ -701,15 +701,15 @@ client.accounts().deleteByApp("app_id");
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**appId:** `String` - +**appId:** `String` +
@@ -764,15 +764,15 @@ client.users().deleteExternalUser("external_user_id");
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**externalUserId:** `String` - +**externalUserId:** `String` +
@@ -834,7 +834,7 @@ client.users().list(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -842,7 +842,7 @@ client.users().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -850,7 +850,7 @@ client.users().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -858,7 +858,7 @@ client.users().list(
**limit:** `Optional` — The maximum number of results to return - +
@@ -866,7 +866,7 @@ client.users().list(
**q:** `Optional` — Filter users by external_id (partial match) - +
@@ -932,7 +932,7 @@ client.components().list(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -940,7 +940,7 @@ client.components().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -948,7 +948,7 @@ client.components().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -956,7 +956,7 @@ client.components().list(
**limit:** `Optional` — The maximum number of results to return - +
@@ -964,7 +964,7 @@ client.components().list(
**q:** `Optional` — A search query to filter the components - +
@@ -972,7 +972,7 @@ client.components().list(
**app:** `Optional` — The ID or name slug of the app to filter the components - +
@@ -980,7 +980,7 @@ client.components().list(
**registry:** `Optional` — The registry to retrieve components from. Defaults to 'all' ('public', 'private', or 'all') - +
@@ -988,7 +988,7 @@ client.components().list(
**componentType:** `Optional` — The type of the component to filter the components - +
@@ -1048,7 +1048,7 @@ client.components().retrieve(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -1056,7 +1056,7 @@ client.components().retrieve(
**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') - +
@@ -1064,7 +1064,7 @@ client.components().retrieve(
**version:** `Optional` — Optional semantic version of the component to retrieve (for example '1.0.0') - +
@@ -1125,15 +1125,15 @@ client.components().configureProp(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**request:** `ConfigurePropOpts` - +**request:** `ConfigurePropOpts` +
@@ -1193,15 +1193,15 @@ client.components().reloadProps(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**request:** `ReloadPropsOpts` - +**request:** `ReloadPropsOpts` +
@@ -1266,7 +1266,7 @@ client.actions().list(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -1274,7 +1274,7 @@ client.actions().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -1282,7 +1282,7 @@ client.actions().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -1290,7 +1290,7 @@ client.actions().list(
**limit:** `Optional` — The maximum number of results to return - +
@@ -1298,7 +1298,7 @@ client.actions().list(
**q:** `Optional` — A search query to filter the actions - +
@@ -1306,7 +1306,7 @@ client.actions().list(
**app:** `Optional` — The ID or name slug of the app to filter the actions - +
@@ -1314,7 +1314,7 @@ client.actions().list(
**registry:** `Optional` — The registry to retrieve actions from. Defaults to 'all' ('public', 'private', or 'all') - +
@@ -1374,7 +1374,7 @@ client.actions().retrieve(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -1382,7 +1382,7 @@ client.actions().retrieve(
**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') - +
@@ -1390,7 +1390,7 @@ client.actions().retrieve(
**version:** `Optional` — Optional semantic version of the component to retrieve (for example '1.0.0') - +
@@ -1451,15 +1451,15 @@ client.actions().configureProp(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**request:** `ConfigurePropOpts` - +**request:** `ConfigurePropOpts` +
@@ -1519,15 +1519,15 @@ client.actions().reloadProps(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**request:** `ReloadPropsOpts` - +**request:** `ReloadPropsOpts` +
@@ -1587,7 +1587,7 @@ client.actions().run(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -1595,7 +1595,7 @@ client.actions().run(
**id:** `String` — The action component ID - +
@@ -1603,7 +1603,7 @@ client.actions().run(
**version:** `Optional` — Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest - +
@@ -1611,15 +1611,15 @@ client.actions().run(
**externalUserId:** `String` — The external user ID - +
-**configuredProps:** `Optional>` - +**configuredProps:** `Optional>` +
@@ -1627,15 +1627,15 @@ client.actions().run(
**dynamicPropsId:** `Optional` — The ID for dynamic props - +
-**stashId:** `Optional` - +**stashId:** `Optional` +
@@ -1700,7 +1700,7 @@ client.triggers().list(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -1708,7 +1708,7 @@ client.triggers().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -1716,7 +1716,7 @@ client.triggers().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -1724,7 +1724,7 @@ client.triggers().list(
**limit:** `Optional` — The maximum number of results to return - +
@@ -1732,7 +1732,7 @@ client.triggers().list(
**q:** `Optional` — A search query to filter the triggers - +
@@ -1740,7 +1740,7 @@ client.triggers().list(
**app:** `Optional` — The ID or name slug of the app to filter the triggers - +
@@ -1748,7 +1748,7 @@ client.triggers().list(
**registry:** `Optional` — The registry to retrieve triggers from. Defaults to 'all' ('public', 'private', or 'all') - +
@@ -1808,7 +1808,7 @@ client.triggers().retrieve(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -1816,7 +1816,7 @@ client.triggers().retrieve(
**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') - +
@@ -1824,7 +1824,7 @@ client.triggers().retrieve(
**version:** `Optional` — Optional semantic version of the component to retrieve (for example '1.0.0') - +
@@ -1885,15 +1885,15 @@ client.triggers().configureProp(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**request:** `ConfigurePropOpts` - +**request:** `ConfigurePropOpts` +
@@ -1953,15 +1953,15 @@ client.triggers().reloadProps(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**request:** `ReloadPropsOpts` - +**request:** `ReloadPropsOpts` +
@@ -2021,7 +2021,7 @@ client.triggers().deploy(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -2029,7 +2029,7 @@ client.triggers().deploy(
**id:** `String` — The trigger component ID - +
@@ -2037,7 +2037,7 @@ client.triggers().deploy(
**version:** `Optional` — Optional trigger component version (in SemVer format, for example '1.0.0'), defaults to latest - +
@@ -2045,15 +2045,15 @@ client.triggers().deploy(
**externalUserId:** `String` — The external user ID - +
-**configuredProps:** `Optional>` - +**configuredProps:** `Optional>` +
@@ -2061,7 +2061,7 @@ client.triggers().deploy(
**dynamicPropsId:** `Optional` — The ID for dynamic props - +
@@ -2069,7 +2069,7 @@ client.triggers().deploy(
**workflowId:** `Optional` — Optional ID of a workflow to receive trigger events - +
@@ -2077,7 +2077,7 @@ client.triggers().deploy(
**webhookUrl:** `Optional` — Optional webhook URL to receive trigger events - +
@@ -2085,7 +2085,7 @@ client.triggers().deploy(
**emitOnDeploy:** `Optional` — Whether the trigger should emit events during the deploy hook execution. Defaults to true if not specified. - +
@@ -2149,7 +2149,7 @@ client.deployedTriggers().list(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -2157,7 +2157,7 @@ client.deployedTriggers().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -2165,7 +2165,7 @@ client.deployedTriggers().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -2173,7 +2173,7 @@ client.deployedTriggers().list(
**limit:** `Optional` — The maximum number of results to return - +
@@ -2181,7 +2181,7 @@ client.deployedTriggers().list(
**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger - +
@@ -2189,7 +2189,7 @@ client.deployedTriggers().list(
**emitterType:** `Optional` — Filter deployed triggers by emitter type (defaults to 'source' if not provided) - +
@@ -2249,15 +2249,15 @@ client.deployedTriggers().retrieve(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
@@ -2265,7 +2265,7 @@ client.deployedTriggers().retrieve(
**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger - +
@@ -2325,15 +2325,15 @@ client.deployedTriggers().update(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
@@ -2341,7 +2341,7 @@ client.deployedTriggers().update(
**externalUserId:** `String` — The external user ID who owns the trigger - +
@@ -2349,15 +2349,15 @@ client.deployedTriggers().update(
**active:** `Optional` — Whether the trigger should be active - +
-**configuredProps:** `Optional>` - +**configuredProps:** `Optional>` +
@@ -2365,7 +2365,7 @@ client.deployedTriggers().update(
**name:** `Optional` — The name of the trigger - +
@@ -2373,7 +2373,7 @@ client.deployedTriggers().update(
**emitOnDeploy:** `Optional` — Whether the trigger should emit events during deployment - +
@@ -2434,15 +2434,15 @@ client.deployedTriggers().delete(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
@@ -2450,7 +2450,7 @@ client.deployedTriggers().delete(
**externalUserId:** `String` — The external user ID who owns the trigger - +
@@ -2458,7 +2458,7 @@ client.deployedTriggers().delete(
**ignoreHookErrors:** `Optional` — Whether to ignore errors during deactivation hook - +
@@ -2519,15 +2519,15 @@ client.deployedTriggers().listEvents(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
@@ -2535,7 +2535,7 @@ client.deployedTriggers().listEvents(
**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger - +
@@ -2543,7 +2543,7 @@ client.deployedTriggers().listEvents(
**n:** `Optional` — The number of events to retrieve (defaults to 20 if not provided) - +
@@ -2603,15 +2603,15 @@ client.deployedTriggers().listWorkflows(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
@@ -2619,7 +2619,7 @@ client.deployedTriggers().listWorkflows(
**externalUserId:** `String` — The external user ID who owns the trigger - +
@@ -2682,15 +2682,15 @@ client.deployedTriggers().updateWorkflows(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
@@ -2698,7 +2698,7 @@ client.deployedTriggers().updateWorkflows(
**externalUserId:** `String` — The external user ID who owns the trigger - +
@@ -2706,7 +2706,7 @@ client.deployedTriggers().updateWorkflows(
**workflowIds:** `List` — Array of workflow IDs to set - +
@@ -2766,15 +2766,15 @@ client.deployedTriggers().listWebhooks(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
@@ -2782,7 +2782,7 @@ client.deployedTriggers().listWebhooks(
**externalUserId:** `String` — The external user ID who owns the trigger - +
@@ -2845,15 +2845,15 @@ client.deployedTriggers().updateWebhooks(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
@@ -2861,7 +2861,7 @@ client.deployedTriggers().updateWebhooks(
**externalUserId:** `String` — The external user ID who owns the trigger - +
@@ -2869,7 +2869,7 @@ client.deployedTriggers().updateWebhooks(
**webhookUrls:** `List` — Array of webhook URLs to set - +
@@ -2930,23 +2930,23 @@ client.deployedTriggers().retrieveWebhook(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
-**webhookId:** `String` - +**webhookId:** `String` +
@@ -2954,7 +2954,7 @@ client.deployedTriggers().retrieveWebhook(
**externalUserId:** `String` — The external user ID who owns the trigger - +
@@ -3015,23 +3015,23 @@ client.deployedTriggers().regenerateWebhookSigningKey(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**triggerId:** `String` - +**triggerId:** `String` +
-**webhookId:** `String` - +**webhookId:** `String` +
@@ -3039,7 +3039,7 @@ client.deployedTriggers().regenerateWebhookSigningKey(
**externalUserId:** `String` — The external user ID who owns the trigger - +
@@ -3094,7 +3094,7 @@ client.projectEnvironment().retrieveWebhook();
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3153,7 +3153,7 @@ client.projectEnvironment().updateWebhook(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3161,7 +3161,7 @@ client.projectEnvironment().updateWebhook(
**url:** `String` — The webhook URL to set - +
@@ -3215,7 +3215,7 @@ client.projectEnvironment().deleteWebhook();
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3269,7 +3269,7 @@ client.projectEnvironment().regenerateWebhookSigningKey();
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3332,7 +3332,7 @@ client.projects().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -3340,7 +3340,7 @@ client.projects().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -3348,7 +3348,7 @@ client.projects().list(
**limit:** `Optional` — The maximum number of results to return - +
@@ -3356,7 +3356,7 @@ client.projects().list(
**q:** `Optional` — A search query to filter the projects - +
@@ -3415,7 +3415,7 @@ client.projects().create(
**name:** `String` — Name of the project - +
@@ -3423,7 +3423,7 @@ client.projects().create(
**appName:** `Optional` — Display name for the Connect application - +
@@ -3431,7 +3431,7 @@ client.projects().create(
**supportEmail:** `Optional` — Support email displayed to end users - +
@@ -3439,7 +3439,7 @@ client.projects().create(
**connectRequireKeyAuthTest:** `Optional` — Send a test request to the upstream API when adding Connect accounts for key-based apps - +
@@ -3493,7 +3493,7 @@ client.projects().retrieve("project_id");
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3547,7 +3547,7 @@ client.projects().delete("project_id");
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3606,7 +3606,7 @@ client.projects().update(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3614,7 +3614,7 @@ client.projects().update(
**name:** `Optional` — Name of the project - +
@@ -3622,7 +3622,7 @@ client.projects().update(
**appName:** `Optional` — Display name for the Connect application - +
@@ -3630,7 +3630,7 @@ client.projects().update(
**supportEmail:** `Optional` — Support email displayed to end users - +
@@ -3638,7 +3638,7 @@ client.projects().update(
**connectRequireKeyAuthTest:** `Optional` — Send a test request to the upstream API when adding Connect accounts for key-based apps - +
@@ -3698,7 +3698,7 @@ client.projects().updateLogo(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3706,7 +3706,7 @@ client.projects().updateLogo(
**logo:** `String` — Data URI containing the new Base64 encoded image - +
@@ -3760,7 +3760,7 @@ client.projects().retrieveInfo();
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3820,15 +3820,15 @@ client.fileStash().downloadFile(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
-**s3Key:** `String` - +**s3Key:** `String` +
@@ -3890,7 +3890,7 @@ client.proxy().get(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3898,7 +3898,7 @@ client.proxy().get(
**url64:** `String` — Base64-encoded target URL - +
@@ -3906,7 +3906,7 @@ client.proxy().get(
**externalUserId:** `String` — The external user ID for the proxy request - +
@@ -3914,7 +3914,7 @@ client.proxy().get(
**accountId:** `String` — The account ID to use for authentication - +
@@ -3960,7 +3960,7 @@ client.proxy().post( .accountId("account_id") .body( new HashMap() {{ - put("string", new + put("string", new HashMap() {{put("key", "value"); }}); }} @@ -3982,7 +3982,7 @@ client.proxy().post(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -3990,7 +3990,7 @@ client.proxy().post(
**url64:** `String` — Base64-encoded target URL - +
@@ -3998,7 +3998,7 @@ client.proxy().post(
**externalUserId:** `String` — The external user ID for the proxy request - +
@@ -4006,7 +4006,7 @@ client.proxy().post(
**accountId:** `String` — The account ID to use for authentication - +
@@ -4014,7 +4014,7 @@ client.proxy().post(
**request:** `Map` — Request body to forward to the target API - +
@@ -4060,7 +4060,7 @@ client.proxy().put( .accountId("account_id") .body( new HashMap() {{ - put("string", new + put("string", new HashMap() {{put("key", "value"); }}); }} @@ -4082,7 +4082,7 @@ client.proxy().put(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -4090,7 +4090,7 @@ client.proxy().put(
**url64:** `String` — Base64-encoded target URL - +
@@ -4098,7 +4098,7 @@ client.proxy().put(
**externalUserId:** `String` — The external user ID for the proxy request - +
@@ -4106,7 +4106,7 @@ client.proxy().put(
**accountId:** `String` — The account ID to use for authentication - +
@@ -4114,7 +4114,7 @@ client.proxy().put(
**request:** `Map` — Request body to forward to the target API - +
@@ -4175,7 +4175,7 @@ client.proxy().delete(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -4183,7 +4183,7 @@ client.proxy().delete(
**url64:** `String` — Base64-encoded target URL - +
@@ -4191,7 +4191,7 @@ client.proxy().delete(
**externalUserId:** `String` — The external user ID for the proxy request - +
@@ -4199,7 +4199,7 @@ client.proxy().delete(
**accountId:** `String` — The account ID to use for authentication - +
@@ -4245,7 +4245,7 @@ client.proxy().patch( .accountId("account_id") .body( new HashMap() {{ - put("string", new + put("string", new HashMap() {{put("key", "value"); }}); }} @@ -4267,7 +4267,7 @@ client.proxy().patch(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -4275,7 +4275,7 @@ client.proxy().patch(
**url64:** `String` — Base64-encoded target URL - +
@@ -4283,7 +4283,7 @@ client.proxy().patch(
**externalUserId:** `String` — The external user ID for the proxy request - +
@@ -4291,7 +4291,7 @@ client.proxy().patch(
**accountId:** `String` — The account ID to use for authentication - +
@@ -4299,7 +4299,7 @@ client.proxy().patch(
**request:** `Map` — Request body to forward to the target API - +
@@ -4359,7 +4359,7 @@ client.tokens().create(
**projectId:** `String` — The project ID, which starts with `proj_`. - +
@@ -4367,7 +4367,7 @@ client.tokens().create(
**allowedOrigins:** `Optional>` — List of allowed origins for CORS - +
@@ -4375,7 +4375,7 @@ client.tokens().create(
**errorRedirectUri:** `Optional` — URI to redirect to on error - +
@@ -4383,7 +4383,7 @@ client.tokens().create(
**expiresIn:** `Optional` — Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified. - +
@@ -4391,7 +4391,7 @@ client.tokens().create(
**externalUserId:** `String` — Your end user ID, for whom you're creating the token - +
@@ -4399,7 +4399,7 @@ client.tokens().create(
**scope:** `Optional` — 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. - +
@@ -4407,7 +4407,7 @@ client.tokens().create(
**successRedirectUri:** `Optional` — URI to redirect to on success - +
@@ -4415,7 +4415,7 @@ client.tokens().create(
**webhookUri:** `Optional` — Webhook URI for notifications - +
@@ -4475,8 +4475,8 @@ client.tokens().validate(
-**ctok:** `String` - +**ctok:** `String` +
@@ -4484,7 +4484,7 @@ client.tokens().validate(
**appId:** `String` — The app ID to validate against - +
@@ -4492,7 +4492,7 @@ client.tokens().validate(
**oauthAppId:** `Optional` — The OAuth app ID to validate against (if the token is for an OAuth app) - +
@@ -4553,7 +4553,7 @@ client.usage().list(
**startTs:** `Integer` — Usage window start timestamp (seconds) - +
@@ -4561,7 +4561,7 @@ client.usage().list(
**endTs:** `Integer` — Usage window end timestamp (seconds) - +
@@ -4622,24 +4622,24 @@ client.oauthTokens().create(
-**grantType:** `String` - +**grantType:** `String` +
-**clientId:** `String` - +**clientId:** `String` +
-**clientSecret:** `String` - +**clientSecret:** `String` +
@@ -4647,7 +4647,206 @@ client.oauthTokens().create(
**scope:** `Optional` — Optional space-separated scopes for the access token. Defaults to `*`. - + +
+ + + + + + + +
+ +## Workflows +
client.workflows.invoke(urlOrEndpoint) -> Object +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +// 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() {{ + put("name", "John Doe"); + put("email", "john@example.com"); + }} + ) + .headers( + new HashMap() {{ + 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` — Request body to send to the workflow (will be JSON serialized) + + + + +
+
+ +**headers:** `Optional>` — Additional headers to include in the request + +
+
+ +
+
+ +**method:** `Optional` — HTTP method to use (defaults to 'POST') + +
+
+ +
+
+ +**authType:** `Optional` — Authentication type: OAUTH (default), STATIC_BEARER, or NONE + +
+
+ + + + + + + + +
client.workflows.invokeForExternalUser(urlOrEndpoint, externalUserId) -> Object +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +// 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() {{ + put("action", "process_data"); + put("data", Arrays.asList("item1", "item2")); + }} + ) + .headers( + new HashMap() {{ + put("X-Custom-Header", "value"); + }} + ) + .method("POST") + .authType(HTTPAuthType.OAUTH) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**url:** `String` — The full workflow URL to invoke + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID for Pipedream Connect authentication + +
+
+ +
+
+ +**body:** `Optional` — Request body to send to the workflow (will be JSON serialized) + + + + +
+
+ +**headers:** `Optional>` — Additional headers to include in the request + +
+
+ +
+
+ +**method:** `Optional` — HTTP method to use (defaults to 'POST') + +
+
+ +
+
+ +**authType:** `Optional` — Authentication type: OAUTH (default), STATIC_BEARER, or NONE +
@@ -4657,3 +4856,4 @@ client.oauthTokens().create( +