diff --git a/docs-v2/pages/connect/api.mdx b/docs-v2/pages/connect/api.mdx index 84251db49dfa2..83f727948730c 100644 --- a/docs-v2/pages/connect/api.mdx +++ b/docs-v2/pages/connect/api.mdx @@ -1601,7 +1601,7 @@ props that were configured so far. See the [Dynamic Props](/connect/components/#configure-dynamic-props-optional) section for more information. ```text -GET /{component_type}/props +POST /{component_type}/props ``` ##### Path parameters @@ -2051,7 +2051,7 @@ The URL to which the trigger will send events. --- -`workflow_url` **string** (_optional_) +`workflow_id` **string** (_optional_) The Pipedream workflow ID to which you want to emit events (ex, `p_1234567`). diff --git a/docs-v2/pages/connect/components.mdx b/docs-v2/pages/connect/components.mdx index e58d3f661b844..e6bc949151e32 100644 --- a/docs-v2/pages/connect/components.mdx +++ b/docs-v2/pages/connect/components.mdx @@ -122,7 +122,8 @@ Here's the response: "custom_fields_json": "[{\"name\":\"base_api_url\",\"label\":\"Base API URL\",\"description\":\"The Base API URL defaults to `gitlab.com`. If you are using self-hosted Gitlab, enter your base url here, e.g. `gitlab.example.com`\",\"default\":\"gitlab.com\",\"optional\":null}]", "categories": [ "Developer Tools" - ] + ], + "featured_weight": 5000 } ] } @@ -820,7 +821,7 @@ These are 2 categories of triggers you can deploy on behalf of your end users: - [Native triggers](#native-triggers) -Refer to the [full Connect API reference](/connect/api/#deploy-a-trigger) to list, retrieve, delete, and manage triggers for your user +Refer to the [full Connect API reference](/connect/api/#deploy-a-trigger) to list, retrieve, delete, and manage triggers for your user. ### App-based event sources @@ -828,6 +829,13 @@ Refer to the [full Connect API reference](/connect/api/#deploy-a-trigger) to lis - Deploying these triggers requires that your customers first connect their account using [Pipedream Connect Managed Auth](/managed-auth/quickstart), since the triggers are deployed on their behalf using account - Refer to the [quickstart above](#deploying-a-source) to get started +#### Handling test events +- Many event sources attempt to retrieve a small set of historical events on deploy to provide visibility into the event shape for end users and developers +- Exposing real test events make it easier to consume the event in downstream systems without requiring users to trigger real events ([more info](/components/contributing/guidelines/#surfacing-test-events)) +- However, this results in emitting those events to the listening webhook immediately, which may not always be ideal, depending on your use case +- If you'd like to avoid emitting historical events, you can deploy a trigger without defining a `webhook_url`, then [update the listening webhooks for the deployed trigger](/connect/api/#update-the-webhooks-listening-to-a-deployed-trigger) after roughly a minute + + ### Native triggers - You can also deploy native triggers, which don't require any authentication from your end users, so **you should skip the account connection process when configuring these triggers** - Because these triggers don't use a connected account from your end users, APIs to deploy and manage them are slightly different (see below) @@ -885,6 +893,21 @@ curl -X POST https://api.pipedream.com/v1/connect/{project_id}/components/trigge #### Schedule Deploy a timer to act as a cron job that will emit an event on a custom schedule you or your users define. +##### Configured props + +`cron` (**object**) + +When defining schedules, you can pass one of the following: +- `intervalSeconds`: Define the frequency in seconds +- `cron`: Define a custom cron schedule and optionally define the `timezone`. For example: + +```json +"cron": { + "cron": "0 * * * *", + "timezone": "America/Los_Angeles" // optional, defaults to UTC +} +``` + ```javascript diff --git a/docs-v2/pages/rest-api/index.mdx b/docs-v2/pages/rest-api/index.mdx index b026841931d2f..2eabee31599d6 100644 --- a/docs-v2/pages/rest-api/index.mdx +++ b/docs-v2/pages/rest-api/index.mdx @@ -390,7 +390,8 @@ curl https://api.pipedream.com/v1/apps "custom_fields_json": "[]", "categories": [ "Communication" - ] + ], + "featured_weight": 1000000001 }, { "id": "app_mWnheL", @@ -402,12 +403,17 @@ curl https://api.pipedream.com/v1/apps "custom_fields_json": "[{\"name\":\"bot_token\",\"label\":\"Bot Token\",\"description\":null,\"default\":null,\"optional\":null,\"type\":\"password\"}]", "categories": [ "Communication" - ] + ], + "featured_weight": 4100 } ] } ``` + +The `apps` API returns a `featured_weight` for integrated apps, which powers the sort order on [pipedream.com/apps](https://pipedream.com/apps). Note that this is roughly based on popularity from Pipedream users, but is manually defined by Pipedream and is subject to change. + + ### Get an App Retrieve metadata for a specific app. @@ -449,6 +455,7 @@ curl https://api.pipedream.com/v1/apps/app_OkrhR1 \ "categories": [ "Communication" ] + "featured_weight": 1000000001 } ] ``` diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 62546fca4143e..48ae732b1ee7d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -6300,8 +6300,7 @@ importers: components/if_else: {} - components/ifthenpay: - specifiers: {} + components/ifthenpay: {} components/ifttt: dependencies: