You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* A few updates
- cron timezones
- featured weights in apps API
- handling test events for deployed triggers
* Update pnpm-lock.yaml
* Update components.mdx
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/components.mdx
+25-2Lines changed: 25 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -122,7 +122,8 @@ Here's the response:
122
122
"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}]",
123
123
"categories": [
124
124
"Developer Tools"
125
-
]
125
+
],
126
+
"featured_weight": 5000
126
127
}
127
128
]
128
129
}
@@ -820,14 +821,21 @@ These are 2 categories of triggers you can deploy on behalf of your end users:
820
821
-[Native triggers](#native-triggers)
821
822
822
823
<Callouttype="info">
823
-
Refer to the [full Connect API reference](/connect/api/#deploy-a-trigger) to list, retrieve, delete, and manage triggers for your user
824
+
Refer to the [full Connect API reference](/connect/api/#deploy-a-trigger) to list, retrieve, delete, and manage triggers for your user.
824
825
</Callout>
825
826
826
827
### App-based event sources
827
828
- Listen for events that occur in other systems: for example, when [a new file is added to Google Drive](https://pipedream.com/apps/google-drive/triggers/new-files-instant) or when [a new contact is created in HubSpot](https://pipedream.com/apps/hubspot/triggers/new-or-updated-contact)
828
829
- 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
829
830
- Refer to the [quickstart above](#deploying-a-source) to get started
830
831
832
+
#### Handling test events
833
+
- 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
834
+
- 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))
835
+
- However, this results in emitting those events to the listening webhook immediately, which may not always be ideal, depending on your use case
836
+
- 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
837
+
838
+
831
839
### Native triggers
832
840
- 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**
833
841
- 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
885
893
#### Schedule
886
894
Deploy a timer to act as a cron job that will emit an event on a custom schedule you or your users define.
887
895
896
+
##### Configured props
897
+
898
+
`cron` (**object**)
899
+
900
+
When defining schedules, you can pass one of the following:
901
+
-`intervalSeconds`: Define the frequency in seconds
902
+
-`cron`: Define a custom cron schedule and optionally define the `timezone`. For example:
903
+
904
+
```json
905
+
"cron": {
906
+
"cron": "0 * * * *",
907
+
"timezone": "America/Los_Angeles"// optional, defaults to UTC
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.
0 commit comments