@@ -108,15 +108,25 @@ of these props implements an `options` method that retrieves the necessary
108108options from the third-party API, formats them, and sends them back in the
109109response for the end user to select.
110110
111- The 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
111+ The payload for the configuration API call must contain the following fields:
112+
113+ 1 . ` external_user_id ` : the ID of your user on your end
114+ 2 . ` id ` : the component's unique ID (aka ** key** )
115+ 3 . ` prop_name ` : the name of the prop you want to configure
116+ 4 . ` configured_props ` : an object containing the props that have already been
117+ configured. The initial configuration call must contain the ID of the account
118+ (aka ` authProvisionId ` ) that your user has connected to the target app (see
119+ [ this section] ( workflows#configure-accounts-to-use-your-end-users-auth ) for
120+ more details on how to create these accounts)
121+
122+ We'll use the [ ** List Commits** component for
114123Gitlab] ( https://github.com/PipedreamHQ/pipedream/blob/master/components/gitlab/actions/list-commits/list-commits.mjs#L4 )
115- as an example, the payload sent to the configuration API would look like this:
124+ as an example, to illustrate a call that retrieves the options for the
125+ ` projectId ` prop of that component. The payload sent to the configuration API
126+ would look like this:
116127
117128``` json
118129{
119- "async_handle" : " qxyTp7QcS2A6" ,
120130 "external_user_id" : " demo-34c13d13-a31e-4a3d-8b63-0ac954671095" ,
121131 "id" : " gitlab-list-commits" ,
122132 "prop_name" : " projectId" ,
@@ -128,13 +138,6 @@ as an example, the payload sent to the configuration API would look like this:
128138}
129139```
130140
131- The 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
133- ` demo-34c13d13-a31e-4a3d-8b63-0ac954671095 ` . The ` authProvisionId ` is the ID of
134- the account that the user has connected to the Gitlab app (see [ this
135- section] ( workflows#configure-accounts-to-use-your-end-users-auth ) for more
136- details on how to create these accounts).
137-
138141The response will contain the possible values (and their human-readable labels
139142when applicable) for the prop, as well as any possible errors that might have
140143occurred. The response for the request above would look like this:
@@ -190,14 +193,14 @@ occurred. The response for the request above would look like this:
190193
191194Fields inside ` configured_props ` are written in camel case since they refer to
192195the names of props as they appear in the component's code, they are not
193- attributes that the API itself consumes. For example, to retrieve the
194- configuration options for the ` refName ` prop:
196+ attributes that the API itself consumes.
195197
196198</Callout >
197199
198200Subsequent prop configuration calls will be identical to the one above, but will
199201incrementally add more props to the ` configured_props ` object, with the name of
200- the prop being configured as the value for the ` prop_name ` attribute.
202+ the prop being configured as the value for the ` prop_name ` attribute. For
203+ example, to retrieve the configuration options for the ` refName ` prop:
201204
202205``` json
203206{
0 commit comments