@@ -22,6 +22,8 @@ guide](/components).
2222
2323## How to run components for your end users
2424
25+ <Steps >
26+
2527### Retrieving a component's definition
2628
2729The first thing to do in order to run a component for your end users is to know
@@ -31,18 +33,18 @@ Pipedream API. See the [component
3133structure] ( /components/api#component-structure ) section in our docs for more
3234details.
3335
34- As an example, the following API call will return the structure of the " List
35- Commits" component for Gitlab:
36+ As an example, the following API call will return the structure of the ** List
37+ Commits** component for Gitlab:
3638
3739``` text
3840GET /v1/connect/components/gitlab-list-commits
3941```
4042
4143The response will contain the component's structure, including its
4244(human-understandable) name, version, and most importantly, the configuration
43- options that the component accepts (also known as " props", which is an
44- abbreviation of "properties"). Here's an example of the response for the
45- component in the example above:
45+ options that the component accepts (also known as [ props] ( /components/api#props )
46+ or "properties"). Here's an example of the response for the component in the
47+ example above:
4648
4749``` json
4850{
@@ -90,7 +92,7 @@ your end users, as described in the next section.
9092### Configuration
9193
9294Component execution on behalf of your end users requires a few preliminary
93- steps, focused on getting the right input parameters (a.k.a.
95+ steps, focused on getting the right input parameters (aka
9496[ props] ( /workflows/using-props ) ) to the component.
9597
9698Configuring each prop for a component usually involves an API call to our
@@ -101,16 +103,14 @@ are static/free-form. The endpoint is accessible at:
101103POST /v1/connect/components/configure
102104```
103105
104- The reason for this back-and-forth is because the options for a prop are usually
105- linked to a specific user's account, and the Pipedream API is the one in charge
106- of contacting the third-party service using the user's credentials, retrieving
107- the necessary data, and sending these options back as a response. Please not
108- that this logic is not implemented by the API itself, but by the component's
109- code; in particular, the ` options ` function of the corresponding prop.
106+ Typically, the options for a prop are linked to a specific user's account. Each
107+ of these props implements an ` options ` method that retrieves the necessary
108+ options from the third-party API, formats them, and sends them back in the
109+ response for the end user to select.
110110
111111The initial configuration call must contain your user's account ID for the
112- target app, and the name of the prop you want to configure. Using the [ " List
113- Commits" component for
112+ target app, and the name of the prop you want to configure. Using the [ ** List
113+ Commits** component for
114114Gitlab] ( https://github.com/PipedreamHQ/pipedream/blob/master/components/gitlab/actions/list-commits/list-commits.mjs#L4 )
115115as an example, the payload sent to the configuration API would look like this:
116116
@@ -129,7 +129,7 @@ as an example, the payload sent to the configuration API would look like this:
129129```
130130
131131The goal of this particular call is to retrieve the options for the ` projectId `
132- prop of the " List Commits" component for Gitlab, for the user with the ID
132+ prop of the ** List Commits** component for Gitlab, for the user with the ID
133133` demo-34c13d13-a31e-4a3d-8b63-0ac954671095 ` . The ` authProvisionId ` is the ID of
134134the account that the user has connected to the Gitlab app (see [ this
135135section] ( workflows#configure-accounts-to-use-your-end-users-auth ) for more
@@ -233,7 +233,7 @@ The payload is similar to the one used for the configuration API, but it
233233excludes the ` prop_name ` field since the goal of this call is to reload and
234234retrieve the new set of props, not to configure a specific one.
235235
236- Using the " Add Single Row" component for Google Sheets as an example, the
236+ Using the ** Add Single Row** component for Google Sheets as an example, the
237237request payload would look like this:
238238
239239``` json
@@ -320,7 +320,7 @@ To illustrate, the response for the request above would look like this:
320320
321321Once all the props have been configured, the component can be invoked. Pipedream
322322supports two types of components: [ actions] ( /components#actions ) and
323- [ sources] ( /components#sources ) (a.k.a. triggers).
323+ [ sources] ( /components#sources ) (aka triggers).
324324
325325Actions are components that perform a task by taking an input either during
326326[ configuration] ( #configuration ) and/or during invocation (usually both), and
@@ -412,7 +412,7 @@ to how a webhook works.
412412
413413Deploying a source is done by sending a payload similar to the one used for
414414running an action, with the addition of the webhook URL mentioned above. Using
415- the " New Issue (Instant)" source for Gitlab as an example, the payload would
415+ the ** New Issue (Instant)** source for Gitlab as an example, the payload would
416416look something like this:
417417
418418``` json
@@ -499,3 +499,5 @@ the source in the future:
499499``` text
500500DELETE /v1/connect/deployed-triggers/dc_dAuGmW7?external_user_id=jverce
501501```
502+
503+ </Steps >
0 commit comments