Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs-v2/pages/connect/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`).

Expand Down
27 changes: 25 additions & 2 deletions docs-v2/pages/connect/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
]
}
Expand Down Expand Up @@ -820,14 +821,21 @@ These are 2 categories of triggers you can deploy on behalf of your end users:
- [Native triggers](#native-triggers)

<Callout type="info">
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.
</Callout>

### App-based event sources
- 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)
- 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 in order 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)
Expand Down Expand Up @@ -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 below:
- `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
}
```

<Tabs items={['Node.js', 'HTTP (cURL)']}>
<Tabs.Tab>
```javascript
Expand Down
11 changes: 9 additions & 2 deletions docs-v2/pages/rest-api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,8 @@ curl https://api.pipedream.com/v1/apps
"custom_fields_json": "[]",
"categories": [
"Communication"
]
],
"featured_weight": 1000000001
},
{
"id": "app_mWnheL",
Expand All @@ -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
}
]
}
```

<Callout type="info">
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.
</Callout>

### Get an App

Retrieve metadata for a specific app.
Expand Down Expand Up @@ -449,6 +455,7 @@ curl https://api.pipedream.com/v1/apps/app_OkrhR1 \
"categories": [
"Communication"
]
"featured_weight": 1000000001
}
]
```
Expand Down
3 changes: 1 addition & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading