picked 0.0.102-next.3 → 0.0.103-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -35,13 +35,13 @@ A run reads, sets and removes its own labels without a scope.
|
|
|
35
35
|
|
|
36
36
|
The **Labels** card shows the labels of one owner, in one section for each namespace.
|
|
37
37
|
|
|
38
|
-
| Page | Where the card shows
|
|
39
|
-
| -------------- |
|
|
40
|
-
| Lead | Next to the responses, or below them on a medium screen. On a narrow screen, it is on the **Labels** tab.
|
|
41
|
-
| Project labels | At `…/<project>/labels`.
|
|
42
|
-
| Run | Below the details of the run. On a narrow screen, the card is on the **Labels** tab.
|
|
38
|
+
| Page | Where the card shows | Scope to change the labels |
|
|
39
|
+
| -------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------ |
|
|
40
|
+
| Lead | Next to the responses, or below them on a medium screen. On a narrow screen, it is on the **Labels** tab. | `ORGANIZATION_LEADS_UPDATE` |
|
|
41
|
+
| Project labels | At `…/<project>/settings/labels`. The page opens for `ORGANIZATION_PROJECTS_READ`. | `ORGANIZATION_PROJECTS_UPDATE` |
|
|
42
|
+
| Run | Below the details of the run. On a narrow screen, the card is on the **Labels** tab. | `ORGANIZATION_PROJECTS_UPDATE` |
|
|
43
43
|
|
|
44
|
-
The project settings
|
|
44
|
+
The project settings have a **Labels** link to the Project labels page. To open the project
|
|
45
45
|
settings, you must have `ORGANIZATION_PROJECTS_UPDATE`.
|
|
46
46
|
|
|
47
47
|
Without the scope, the card shows the labels, and you cannot change them.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: reference
|
|
3
|
+
layout: docs
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Workflow tools
|
|
7
|
+
|
|
8
|
+
A tool node runs one tool. The inspector of the node shows the name of the tool and a short
|
|
9
|
+
description. This page gives the full reference for each tool.
|
|
10
|
+
|
|
11
|
+
The header of a tool node shows the name of the tool. To show a different name on the node,
|
|
12
|
+
type it in the **Title** field of the inspector. A title can have 80 characters or fewer. A
|
|
13
|
+
condition node also has a **Title** field. Without a title, a condition node shows its rules
|
|
14
|
+
in short form.
|
|
15
|
+
|
|
16
|
+
## Tools
|
|
17
|
+
|
|
18
|
+
| Tool | Name in the editor | What it does | Output |
|
|
19
|
+
| ----------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
|
|
20
|
+
| `workflow_noop` | **Log a message** | Records the text in its `message` argument on the node. | `message` |
|
|
21
|
+
| `search_leads` | **Search leads** | Finds the leads that match a query in the leads query language, the newest lead first. It finds 20 or fewer. | `leads` |
|
|
22
|
+
| `get_lead` | **Get lead** | Reads the lead of the visitor whose action started the run. `exists` is `false` when the visitor has no lead. | `lead` and `exists` |
|
|
23
|
+
| `create_lead` | **Create lead** | Creates a lead for the visitor, and sets the labels in its `labels` argument on it. | `lead`, `created` and `labelCount` |
|
|
24
|
+
| `set_lead_labels` | **Set lead labels** | Adds labels to the lead in its `lead` argument, or changes them. | `lead` and `count` |
|
|
25
|
+
| `remove_lead_labels` | **Remove lead labels** | Removes labels from the lead in its `lead` argument. | `lead` and `removed` |
|
|
26
|
+
| `set_project_labels` | **Set project labels** | Adds labels to the project of the run, or changes them. | `project` and `count` |
|
|
27
|
+
| `remove_project_labels` | **Remove project labels** | Removes labels from the project of the run. | `project` and `removed` |
|
|
28
|
+
| `get_project` | **Get project** | Reads the project of the run and its labels. | `project` |
|
|
29
|
+
| `set_run_labels` | **Set run labels** | Adds labels to the run, or changes them. | `run` and `count` |
|
|
30
|
+
| `remove_run_labels` | **Remove run labels** | Removes labels from the run. | `run` and `removed` |
|
|
31
|
+
| `get_run` | **Get run** | Reads the run and its labels. | `run` |
|
|
32
|
+
| `http` | **External API** | Sends a request to an external API that the project registered. The registration holds the credential. | `status`, `ok`, `body`, `bodyTruncated` and `durationMs` |
|
|
33
|
+
| `action_response` | **Action response** | Sends the payload in its `payload` argument to the visitor who started the action in its `actionId` argument. | `actionId` and `recorded` |
|
|
34
|
+
|
|
35
|
+
## Labels
|
|
36
|
+
|
|
37
|
+
A row of a label tool can expire. It can set a label only when the owner does not have it. It
|
|
38
|
+
can add to a `number` label. A row of a remove tool can remove a label only when the label
|
|
39
|
+
has a given value. For the arguments, the outputs and the scopes of the label tools, refer to
|
|
40
|
+
the [labels reference](/reference/dashboard/labels#tools).
|
|
41
|
+
|
|
42
|
+
## External APIs
|
|
43
|
+
|
|
44
|
+
For the arguments of **External API** and how to register an API, refer to
|
|
45
|
+
[Call an external API from a workflow](/how-to/call-an-external-api-from-a-workflow).
|
|
46
|
+
|
|
47
|
+
## Action responses
|
|
48
|
+
|
|
49
|
+
For **Action response**, refer to
|
|
50
|
+
[Wait for an action response](/how-to/wait-for-an-action-response).
|
|
51
|
+
|
|
52
|
+
## Failures
|
|
53
|
+
|
|
54
|
+
When a tool fails, the node fails. An edge on the error exit of the node can continue the
|
|
55
|
+
run. Refer to the [workflow runs reference](/reference/dashboard/workflow-runs#run-status).
|
|
@@ -305,6 +305,10 @@ type WorkflowToolNode implements WorkflowNode {
|
|
|
305
305
|
tool: String!
|
|
306
306
|
"""The values of the arguments of the tool."""
|
|
307
307
|
configuration: JSON!
|
|
308
|
+
"""
|
|
309
|
+
The title the author gave the node. Null when the canvas shows the name of the tool.
|
|
310
|
+
"""
|
|
311
|
+
title: String
|
|
308
312
|
}
|
|
309
313
|
```
|
|
310
314
|
|
|
@@ -323,6 +327,10 @@ type WorkflowConditionNode implements WorkflowNode {
|
|
|
323
327
|
position: Position!
|
|
324
328
|
"""The rule the node evaluates."""
|
|
325
329
|
logic: JSON!
|
|
330
|
+
"""
|
|
331
|
+
The title the author gave the node. Null when the canvas shows a summary of the rule.
|
|
332
|
+
"""
|
|
333
|
+
title: String
|
|
326
334
|
}
|
|
327
335
|
```
|
|
328
336
|
|
|
@@ -373,6 +381,8 @@ input WorkflowToolNodeInput {
|
|
|
373
381
|
The values of the arguments of the tool. Omit for a tool with no arguments.
|
|
374
382
|
"""
|
|
375
383
|
configuration: JSON
|
|
384
|
+
"""A title for the node, at most 80 characters. Omit for none."""
|
|
385
|
+
title: String
|
|
376
386
|
}
|
|
377
387
|
```
|
|
378
388
|
|
|
@@ -383,6 +393,8 @@ input WorkflowToolNodeInput {
|
|
|
383
393
|
input WorkflowConditionNodeInput {
|
|
384
394
|
"""The rule the node evaluates."""
|
|
385
395
|
logic: JSON!
|
|
396
|
+
"""A title for the node, at most 80 characters. Omit for none."""
|
|
397
|
+
title: String
|
|
386
398
|
}
|
|
387
399
|
```
|
|
388
400
|
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "picked",
|
|
3
3
|
"description": "The Picked SDK front door: the client, the picked.config helpers, and the picked CLI in one install",
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "0.0.103-next.1",
|
|
5
5
|
"bin": {
|
|
6
6
|
"picked": "dist/esm/bin.js"
|
|
7
7
|
},
|
|
8
8
|
"dependencies": {
|
|
9
|
-
"@picked/cli": "0.0.
|
|
10
|
-
"@picked/config": "0.0.
|
|
9
|
+
"@picked/cli": "0.0.103-next.1",
|
|
10
|
+
"@picked/config": "0.0.103-next.1"
|
|
11
11
|
},
|
|
12
12
|
"devDependencies": {
|
|
13
13
|
"@picked/client": "workspace:*",
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
"main": "./dist/cjs/index.js",
|
|
65
65
|
"module": "./dist/esm/index.js",
|
|
66
66
|
"peerDependencies": {
|
|
67
|
-
"@picked/client": "0.0.
|
|
67
|
+
"@picked/client": "0.0.103-next.1"
|
|
68
68
|
},
|
|
69
69
|
"private": false,
|
|
70
70
|
"publishConfig": {
|