Reference

AppCategories

client.appCategories.list() -> Pipedream.ListAppCategoriesResponse

📝 Description

Retrieve all available categories for integrated apps

🔌 Usage

await client.appCategories.list();

⚙️ Parameters

requestOptions: AppCategoriesClient.RequestOptions

client.appCategories.retrieve(id) -> Pipedream.GetAppCategoryResponse

📝 Description

Get details of a specific app category by its ID

🔌 Usage

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

⚙️ Parameters

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

requestOptions: AppCategoriesClient.RequestOptions

Apps

client.apps.list({ ...params }) -> core.Page<Pipedream.App, Pipedream.ListAppsResponse>

📝 Description

Retrieve all available apps with optional filtering and sorting

🔌 Usage

const pageableResponse = await client.apps.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q",
    sortKey: "name",
    sortDirection: "asc",
    categoryIds: ["category_ids"],
    hasComponents: true,
    hasActions: true,
    hasTriggers: true
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.apps.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q",
    sortKey: "name",
    sortDirection: "asc",
    categoryIds: ["category_ids"],
    hasComponents: true,
    hasActions: true,
    hasTriggers: true
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

⚙️ Parameters

request: Pipedream.AppsListRequest

requestOptions: AppsClient.RequestOptions

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

📝 Description

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

🔌 Usage

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

⚙️ Parameters

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

requestOptions: AppsClient.RequestOptions

Accounts

client.accounts.list({ ...params }) -> core.Page<Pipedream.Account, Pipedream.ListAccountsResponse>

📝 Description

Retrieve all connected accounts for the project with optional filtering

🔌 Usage

const pageableResponse = await client.accounts.list({
    externalUserId: "external_user_id",
    oauthAppId: "oauth_app_id",
    after: "after",
    before: "before",
    limit: 1,
    app: "app",
    includeCredentials: true
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.accounts.list({
    externalUserId: "external_user_id",
    oauthAppId: "oauth_app_id",
    after: "after",
    before: "before",
    limit: 1,
    app: "app",
    includeCredentials: true
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

⚙️ Parameters

request: Pipedream.AccountsListRequest

requestOptions: AccountsClient.RequestOptions

client.accounts.create({ ...params }) -> Pipedream.Account

📝 Description

Connect a new account for an external user in the project

🔌 Usage

await client.accounts.create({
    externalUserId: "external_user_id",
    oauthAppId: "oauth_app_id",
    appSlug: "app_slug",
    cfmapJson: "cfmap_json",
    connectToken: "connect_token"
});

⚙️ Parameters

request: Pipedream.CreateAccountOpts

requestOptions: AccountsClient.RequestOptions

client.accounts.retrieve(account_id, { ...params }) -> Pipedream.Account

📝 Description

Get the details for a specific connected account

🔌 Usage

await client.accounts.retrieve("account_id", {
    includeCredentials: true
});

⚙️ Parameters

account_id: string

request: Pipedream.AccountsRetrieveRequest

requestOptions: AccountsClient.RequestOptions

client.accounts.delete(account_id) -> void

📝 Description

Remove a connected account and its associated credentials

🔌 Usage

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

⚙️ Parameters

account_id: string

requestOptions: AccountsClient.RequestOptions

client.accounts.deleteByApp(app_id) -> void

📝 Description

Remove all connected accounts for a specific app

🔌 Usage

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

⚙️ Parameters

app_id: string

requestOptions: AccountsClient.RequestOptions

Users

client.users.deleteExternalUser(external_user_id) -> void

📝 Description

Remove an external user and all their associated accounts and resources

🔌 Usage

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

⚙️ Parameters

external_user_id: string

requestOptions: UsersClient.RequestOptions

client.users.list({ ...params }) -> core.Page<Pipedream.ExternalUser, Pipedream.GetUsersResponse>

📝 Description

Retrieve all external users for the project

🔌 Usage

const pageableResponse = await client.users.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q"
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.users.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

⚙️ Parameters

request: Pipedream.UsersListRequest

requestOptions: UsersClient.RequestOptions

Components

client.components.list({ ...params }) -> core.Page<Pipedream.Component, Pipedream.GetComponentsResponse>

📝 Description

Retrieve available components with optional search and app filtering

🔌 Usage

const pageableResponse = await client.components.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q",
    app: "app",
    registry: "public",
    componentType: "trigger"
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.components.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q",
    app: "app",
    registry: "public",
    componentType: "trigger"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

⚙️ Parameters

request: Pipedream.ComponentsListRequest

requestOptions: ComponentsClient.RequestOptions

client.components.retrieve(component_id, { ...params }) -> Pipedream.GetComponentResponse

📝 Description

Get detailed configuration for a specific component by its key

🔌 Usage

await client.components.retrieve("component_id", {
    version: "1.2.3"
});

⚙️ Parameters

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

request: Pipedream.ComponentsRetrieveRequest

requestOptions: ComponentsClient.RequestOptions

client.components.configureProp({ ...params }) -> Pipedream.ConfigurePropResponse

📝 Description

Retrieve remote options for a given prop for a component

🔌 Usage

await client.components.configureProp({
    id: "id",
    externalUserId: "external_user_id",
    propName: "prop_name"
});

⚙️ Parameters

request: Pipedream.ConfigurePropOpts

requestOptions: ComponentsClient.RequestOptions

client.components.reloadProps({ ...params }) -> Pipedream.ReloadPropsResponse

📝 Description

Reload the prop definition based on the currently configured props

🔌 Usage

await client.components.reloadProps({
    id: "id",
    externalUserId: "external_user_id"
});

⚙️ Parameters

request: Pipedream.ReloadPropsOpts

requestOptions: ComponentsClient.RequestOptions

Actions

client.actions.list({ ...params }) -> core.Page<Pipedream.Component, Pipedream.GetComponentsResponse>

📝 Description

Retrieve available actions with optional search and app filtering

🔌 Usage

const pageableResponse = await client.actions.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q",
    app: "app",
    registry: "public"
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.actions.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q",
    app: "app",
    registry: "public"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

⚙️ Parameters

request: Pipedream.ActionsListRequest

requestOptions: ActionsClient.RequestOptions

client.actions.retrieve(component_id, { ...params }) -> Pipedream.GetComponentResponse

📝 Description

Get detailed configuration for a specific action by its key

🔌 Usage

await client.actions.retrieve("component_id", {
    version: "1.2.3"
});

⚙️ Parameters

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

request: Pipedream.ActionsRetrieveRequest

requestOptions: ActionsClient.RequestOptions

client.actions.configureProp({ ...params }) -> Pipedream.ConfigurePropResponse

📝 Description

Retrieve remote options for a given prop for a action

🔌 Usage

await client.actions.configureProp({
    id: "id",
    externalUserId: "external_user_id",
    propName: "prop_name"
});

⚙️ Parameters

request: Pipedream.ConfigurePropOpts

requestOptions: ActionsClient.RequestOptions

client.actions.reloadProps({ ...params }) -> Pipedream.ReloadPropsResponse

📝 Description

Reload the prop definition based on the currently configured props

🔌 Usage

await client.actions.reloadProps({
    id: "id",
    externalUserId: "external_user_id"
});

⚙️ Parameters

request: Pipedream.ReloadPropsOpts

requestOptions: ActionsClient.RequestOptions

client.actions.run({ ...params }) -> Pipedream.RunActionResponse

📝 Description

Execute an action with the provided configuration and return results

🔌 Usage

await client.actions.run({
    id: "id",
    externalUserId: "external_user_id"
});

⚙️ Parameters

request: Pipedream.RunActionOpts

requestOptions: ActionsClient.RequestOptions

Triggers

client.triggers.list({ ...params }) -> core.Page<Pipedream.Component, Pipedream.GetComponentsResponse>

📝 Description

Retrieve available triggers with optional search and app filtering

🔌 Usage

const pageableResponse = await client.triggers.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q",
    app: "app",
    registry: "public"
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.triggers.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q",
    app: "app",
    registry: "public"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

⚙️ Parameters

request: Pipedream.TriggersListRequest

requestOptions: TriggersClient.RequestOptions

client.triggers.retrieve(component_id, { ...params }) -> Pipedream.GetComponentResponse

📝 Description

Get detailed configuration for a specific trigger by its key

🔌 Usage

await client.triggers.retrieve("component_id", {
    version: "1.2.3"
});

⚙️ Parameters

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

request: Pipedream.TriggersRetrieveRequest

requestOptions: TriggersClient.RequestOptions

client.triggers.configureProp({ ...params }) -> Pipedream.ConfigurePropResponse

📝 Description

Retrieve remote options for a given prop for a trigger

🔌 Usage

await client.triggers.configureProp({
    id: "id",
    externalUserId: "external_user_id",
    propName: "prop_name"
});

⚙️ Parameters

request: Pipedream.ConfigurePropOpts

requestOptions: TriggersClient.RequestOptions

client.triggers.reloadProps({ ...params }) -> Pipedream.ReloadPropsResponse

📝 Description

Reload the prop definition based on the currently configured props

🔌 Usage

await client.triggers.reloadProps({
    id: "id",
    externalUserId: "external_user_id"
});

⚙️ Parameters

request: Pipedream.ReloadPropsOpts

requestOptions: TriggersClient.RequestOptions

client.triggers.deploy({ ...params }) -> Pipedream.DeployTriggerResponse

📝 Description

Deploy a trigger to listen for and emit events

🔌 Usage

await client.triggers.deploy({
    id: "id",
    externalUserId: "external_user_id"
});

⚙️ Parameters

request: Pipedream.DeployTriggerOpts

requestOptions: TriggersClient.RequestOptions

DeployedTriggers

client.deployedTriggers.list({ ...params }) -> core.Page<Pipedream.Emitter, Pipedream.GetTriggersResponse>

📝 Description

Retrieve all deployed triggers for a specific external user

🔌 Usage

const pageableResponse = await client.deployedTriggers.list({
    after: "after",
    before: "before",
    limit: 1,
    externalUserId: "external_user_id",
    emitterType: "email"
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.deployedTriggers.list({
    after: "after",
    before: "before",
    limit: 1,
    externalUserId: "external_user_id",
    emitterType: "email"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

⚙️ Parameters

request: Pipedream.DeployedTriggersListRequest

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.retrieve(trigger_id, { ...params }) -> Pipedream.GetTriggerResponse

📝 Description

Get details of a specific deployed trigger by its ID

🔌 Usage

await client.deployedTriggers.retrieve("trigger_id", {
    externalUserId: "external_user_id"
});

⚙️ Parameters

trigger_id: string

request: Pipedream.DeployedTriggersRetrieveRequest

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.update(trigger_id, { ...params }) -> Pipedream.GetTriggerResponse

📝 Description

Modify the configuration of a deployed trigger, including active status

🔌 Usage

await client.deployedTriggers.update("trigger_id", {
    externalUserId: "external_user_id"
});

⚙️ Parameters

trigger_id: string

request: Pipedream.UpdateTriggerOpts

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.delete(trigger_id, { ...params }) -> void

📝 Description

Remove a deployed trigger and stop receiving events

🔌 Usage

await client.deployedTriggers.delete("trigger_id", {
    externalUserId: "external_user_id",
    ignoreHookErrors: true
});

⚙️ Parameters

trigger_id: string

request: Pipedream.DeployedTriggersDeleteRequest

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.listEvents(trigger_id, { ...params }) -> Pipedream.GetTriggerEventsResponse

📝 Description

Retrieve recent events emitted by a deployed trigger

🔌 Usage

await client.deployedTriggers.listEvents("trigger_id", {
    externalUserId: "external_user_id",
    n: 1
});

⚙️ Parameters

trigger_id: string

request: Pipedream.DeployedTriggersListEventsRequest

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.listWorkflows(trigger_id, { ...params }) -> Pipedream.GetTriggerWorkflowsResponse

📝 Description

Get workflows connected to receive events from this trigger

🔌 Usage

await client.deployedTriggers.listWorkflows("trigger_id", {
    externalUserId: "external_user_id"
});

⚙️ Parameters

trigger_id: string

request: Pipedream.DeployedTriggersListWorkflowsRequest

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.updateWorkflows(trigger_id, { ...params }) -> Pipedream.GetTriggerWorkflowsResponse

📝 Description

Connect or disconnect workflows to receive trigger events

🔌 Usage

await client.deployedTriggers.updateWorkflows("trigger_id", {
    externalUserId: "external_user_id",
    workflowIds: ["workflow_ids"]
});

⚙️ Parameters

trigger_id: string

request: Pipedream.UpdateTriggerWorkflowsOpts

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.listWebhooks(trigger_id, { ...params }) -> Pipedream.GetTriggerWebhooksResponse

📝 Description

Get webhook URLs configured to receive trigger events

🔌 Usage

await client.deployedTriggers.listWebhooks("trigger_id", {
    externalUserId: "external_user_id"
});

⚙️ Parameters

trigger_id: string

request: Pipedream.DeployedTriggersListWebhooksRequest

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.updateWebhooks(trigger_id, { ...params }) -> Pipedream.GetTriggerWebhooksResponse

📝 Description

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

🔌 Usage

await client.deployedTriggers.updateWebhooks("trigger_id", {
    externalUserId: "external_user_id",
    webhookUrls: ["webhook_urls"]
});

⚙️ Parameters

trigger_id: string

request: Pipedream.UpdateTriggerWebhooksOpts

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.retrieveWebhook(trigger_id, webhook_id, { ...params }) -> Pipedream.GetWebhookWithSigningKeyResponse

📝 Description

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

🔌 Usage

await client.deployedTriggers.retrieveWebhook("trigger_id", "webhook_id", {
    externalUserId: "external_user_id"
});

⚙️ Parameters

trigger_id: string

webhook_id: string

request: Pipedream.DeployedTriggersRetrieveWebhookRequest

requestOptions: DeployedTriggersClient.RequestOptions

client.deployedTriggers.regenerateWebhookSigningKey(trigger_id, webhook_id, { ...params }) -> Pipedream.GetWebhookWithSigningKeyResponse

📝 Description

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

🔌 Usage

await client.deployedTriggers.regenerateWebhookSigningKey("trigger_id", "webhook_id", {
    externalUserId: "external_user_id"
});

⚙️ Parameters

trigger_id: string

webhook_id: string

request: Pipedream.DeployedTriggersRegenerateWebhookSigningKeyRequest

requestOptions: DeployedTriggersClient.RequestOptions

ProjectEnvironment

client.projectEnvironment.retrieveWebhook() -> Pipedream.GetWebhookResponse

📝 Description

Retrieve the webhook configured for a project environment

🔌 Usage

await client.projectEnvironment.retrieveWebhook();

⚙️ Parameters

requestOptions: ProjectEnvironmentClient.RequestOptions

client.projectEnvironment.updateWebhook({ ...params }) -> Pipedream.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

await client.projectEnvironment.updateWebhook({
    url: "url"
});

⚙️ Parameters

request: Pipedream.SetWebhookOpts

requestOptions: ProjectEnvironmentClient.RequestOptions

client.projectEnvironment.deleteWebhook() -> void

📝 Description

Remove the webhook configured for a project environment

🔌 Usage

await client.projectEnvironment.deleteWebhook();

⚙️ Parameters

requestOptions: ProjectEnvironmentClient.RequestOptions

client.projectEnvironment.regenerateWebhookSigningKey() -> Pipedream.GetWebhookWithSigningKeyResponse

📝 Description

Regenerate the signing key for the project environment webhook

🔌 Usage

await client.projectEnvironment.regenerateWebhookSigningKey();

⚙️ Parameters

requestOptions: ProjectEnvironmentClient.RequestOptions

Projects

client.projects.list({ ...params }) -> core.Page<Pipedream.Project, Pipedream.ListProjectsResponse>

📝 Description

List the projects that are available to the authenticated Connect client

🔌 Usage

const pageableResponse = await client.projects.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q"
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.projects.list({
    after: "after",
    before: "before",
    limit: 1,
    q: "q"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

⚙️ Parameters

request: Pipedream.ProjectsListRequest

requestOptions: ProjectsClient.RequestOptions

client.projects.create({ ...params }) -> Pipedream.Project

📝 Description

Create a new project for the authenticated workspace

🔌 Usage

await client.projects.create({
    name: "name"
});

⚙️ Parameters

request: Pipedream.CreateProjectOpts

requestOptions: ProjectsClient.RequestOptions

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

📝 Description

Get the project details for a specific project

🔌 Usage

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

⚙️ Parameters

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

requestOptions: ProjectsClient.RequestOptions

client.projects.delete(project_id) -> void

📝 Description

Delete a project owned by the authenticated workspace

🔌 Usage

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

⚙️ Parameters

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

requestOptions: ProjectsClient.RequestOptions

client.projects.update(project_id, { ...params }) -> Pipedream.Project

📝 Description

Update project details or application information

🔌 Usage

await client.projects.update("project_id");

⚙️ Parameters

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

request: Pipedream.UpdateProjectOpts

requestOptions: ProjectsClient.RequestOptions

client.projects.updateLogo(project_id, { ...params }) -> void

📝 Description

Upload or replace the project logo

🔌 Usage

await client.projects.updateLogo("project_id", {
    logo: "data:image/png;base64,AAAAAA..."
});

⚙️ Parameters

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

request: Pipedream.UpdateProjectLogoOpts

requestOptions: ProjectsClient.RequestOptions

client.projects.retrieveInfo() -> Pipedream.ProjectInfoResponse

📝 Description

Retrieve project configuration and environment details

🔌 Usage

await client.projects.retrieveInfo();

⚙️ Parameters

requestOptions: ProjectsClient.RequestOptions

FileStash

client.fileStash.downloadFile({ ...params }) -> core.BinaryResponse

📝 Description

Download a file from File Stash

🔌 Usage

await client.fileStash.downloadFile({
    s3Key: "s3_key"
});

⚙️ Parameters

request: Pipedream.FileStashDownloadFileRequest

requestOptions: FileStashClient.RequestOptions

Proxy

client.proxy.get({ ...params }) -> core.BinaryResponse

📝 Description

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

🔌 Usage

await client.proxy.get({
    url: "https://api.example.com/endpoint",
    externalUserId: "external_user_id",
    accountId: "account_id",
    params: { key: "value" },
    headers: { "X-Custom-Header": "value" }
});

⚙️ Parameters

request: Pipedream.ProxyGetRequest

requestOptions: ProxyClient.RequestOptions

client.proxy.post({ ...params }) -> core.BinaryResponse

📝 Description

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

🔌 Usage

await client.proxy.post({
    url: "https://api.example.com/endpoint",
    externalUserId: "external_user_id",
    accountId: "account_id",
    body: { name: "Alice" },
    headers: { "Content-Type": "application/json" }
});

⚙️ Parameters

request: Pipedream.ProxyPostRequest

requestOptions: ProxyClient.RequestOptions

client.proxy.put({ ...params }) -> core.BinaryResponse

📝 Description

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

🔌 Usage

await client.proxy.put({
    url: "https://api.example.com/endpoint",
    externalUserId: "external_user_id",
    accountId: "account_id",
    body: { name: "Alice" },
    headers: { "Content-Type": "application/json" }
});

⚙️ Parameters

request: Pipedream.ProxyPutRequest

requestOptions: ProxyClient.RequestOptions

client.proxy.delete({ ...params }) -> core.BinaryResponse

📝 Description

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

🔌 Usage

await client.proxy.delete({
    url: "https://api.example.com/endpoint",
    externalUserId: "external_user_id",
    accountId: "account_id"
});

⚙️ Parameters

request: Pipedream.ProxyDeleteRequest

requestOptions: ProxyClient.RequestOptions

client.proxy.patch({ ...params }) -> core.BinaryResponse

📝 Description

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

🔌 Usage

await client.proxy.patch({
    url: "https://api.example.com/endpoint",
    externalUserId: "external_user_id",
    accountId: "account_id",
    body: { name: "Alice" },
    headers: { "Content-Type": "application/json" }
});

⚙️ Parameters

request: Pipedream.ProxyPatchRequest

requestOptions: ProxyClient.RequestOptions

Tokens

client.tokens.create({ ...params }) -> Pipedream.CreateTokenResponse

📝 Description

Generate a Connect token to use for client-side authentication

🔌 Usage

await client.tokens.create({
    externalUserId: "external_user_id"
});

⚙️ Parameters

request: Pipedream.CreateTokenOpts

requestOptions: TokensClient.RequestOptions

client.tokens.validate(ctok, { ...params }) -> Pipedream.ValidateTokenResponse

📝 Description

Confirm the validity of a Connect token

🔌 Usage

await client.tokens.validate("ctok", {
    appId: "app_id",
    accountId: "account_id",
    oauthAppId: "oauth_app_id"
});

⚙️ Parameters

ctok: Pipedream.ConnectToken

request: Pipedream.TokensValidateRequest

requestOptions: TokensClient.RequestOptions

Usage

client.usage.list({ ...params }) -> Pipedream.ConnectUsageResponse

📝 Description

Retrieve Connect usage records for a time window

🔌 Usage

await client.usage.list({
    startTs: 1,
    endTs: 1
});

⚙️ Parameters

request: Pipedream.UsageListRequest

requestOptions: UsageClient.RequestOptions

OauthTokens

client.oauthTokens.create({ ...params }) -> Pipedream.CreateOAuthTokenResponse

📝 Description

Exchange OAuth credentials for an access token

🔌 Usage

await client.oauthTokens.create({
    clientId: "client_id",
    clientSecret: "client_secret"
});

⚙️ Parameters

request: Pipedream.CreateOAuthTokenOpts

requestOptions: OauthTokensClient.RequestOptions

Workflows

client.workflows.invoke({ ...params }, authType?) -> unknown

📝 Description

Invokes a workflow using the URL of its HTTP interface(s), by sending an HTTP request.

🔌 Usage

// Invoke with URL
await client.workflows.invoke({
    urlOrEndpoint: "https://en-your-endpoint.m.pipedream.net",
    body: {
        foo: 123,
        bar: "abc",
        baz: null,
    },
    headers: {
        Accept: "application/json",
    },
});

// Invoke with endpoint ID
await client.workflows.invoke({
    urlOrEndpoint: "en123",
    body: {
        message: "Hello, World!",
    },
}, Pipedream.HTTPAuthType.OAuth);

⚙️ Parameters

request: Pipedream.InvokeWorkflowOpts

authType: Pipedream.HTTPAuthType — The type of authorization to use for the request (defaults to None)

requestOptions: WorkflowsClient.RequestOptions

client.workflows.invokeForExternalUser({ ...params }) -> unknown

📝 Description

Invokes a workflow for a specific Pipedream Connect external user.

🔌 Usage

await client.workflows.invokeForExternalUser({
    urlOrEndpoint: "https://your-workflow-url.m.pipedream.net",
    externalUserId: "your-external-user-id",
    body: {
        foo: 123,
        bar: "abc",
        baz: null,
    },
    headers: {
        Accept: "application/json",
    },
});

⚙️ Parameters

request: Pipedream.InvokeWorkflowForExternalUserOpts

requestOptions: WorkflowsClient.RequestOptions

Uh oh!

FilesExpand file tree

reference.md

Latest commit

History

reference.md

File metadata and controls

Reference

AppCategories

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Apps

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Accounts

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Users

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Components

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Actions

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

Triggers

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage