Skip to content

Commit 9db0173

Browse files
author
Igor Drobiazko
committed
Added help texts
1 parent e251755 commit 9db0173

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

component.json

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@
1515
"triggers": {
1616
"receive": {
1717
"title": "Receive",
18-
"description": "Simple webhook trigger which receives data as an input and starts the flow execution after this.",
18+
"help": {
19+
"description": "Receives data from an external system to a given URL to start a new execution of the flow. Each incoming request results in a new execution.",
20+
"link": "/components/webhook/index.html#receive"
21+
},
1922
"main": "./lib/triggers/receive.js",
2023
"metadata": {
2124
"in": {},
@@ -26,6 +29,10 @@
2629
"actions": {
2730
"post": {
2831
"title": "Send data",
32+
"help": {
33+
"description": "Sends data to a provided URL.",
34+
"link": "/components/webhook/index.html#send-data"
35+
},
2936
"main": "./lib/actions/send.js",
3037
"fields": {
3138
"method": {
@@ -36,17 +43,26 @@
3643
"model": {
3744
"POST": "POST",
3845
"PUT": "PUT"
46+
},
47+
"help": {
48+
"description": "Used to specify the HTTP request method for the given URI."
3949
}
4050
},
4151
"uri": {
4252
"viewClass": "TextFieldView",
4353
"label": "URI",
44-
"required": true
54+
"required": true,
55+
"help": {
56+
"description": "The URI to send data to."
57+
}
4558
},
4659
"secret": {
4760
"viewClass": "TextFieldView",
4861
"label": "Secret",
49-
"required": false
62+
"required": false,
63+
"help": {
64+
"description": "May be used to prove the identity of the request sender. The value provided into this field will be sent as 'X-Api-Secret' HTTP header which may be checked on the receiving system."
65+
}
5066
}
5167
},
5268
"metadata": {

0 commit comments

Comments
 (0)