Skip to content

Commit c7cf284

Browse files
committed
docs: button run script
Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
1 parent 2200bc6 commit c7cf284

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

content/docs/fields/field-types/custom-types/button.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,14 @@ tags: ['Fields', 'Field types', 'Custom types', 'Button']
55
keywords: ['Fields', 'Field types', 'Custom types', 'Button', 'Create button field']
66
---
77

8-
The **Button** Field allows users to create interactive buttons within their tables. These buttons can trigger specific actions, making workflows more dynamic and efficient. With the Button Field, you can navigate to external URLs, run custom webhooks, or even run custom scripts (coming soon!) with a single click.
8+
The **Button** Field allows users to create interactive buttons within their tables. These buttons can trigger specific actions, making workflows more dynamic and efficient. With the Button Field, you can navigate to external URLs, run custom webhooks, or even run custom scripts with a single click.
99

10-
NocoDB currently supports two types of actions for the Button Field:
10+
NocoDB currently supports following actions for the Button Field:
1111
1. **Open URL**: Opens a new tab with a URL generated by a formula within the button field. The URL can be static or dynamic based on the current record's data.
1212
2. **Run Webhook**: Trigger a webhook with the configured URL & custom payload. Payload can include data from the current record.
13+
3. **Run Script**: Execute a custom script that can perform various operations on the current record or the entire table. Current record information can be accessed using the `row` variable in the script.
14+
15+
<Callout type="note">**Run Script** action is currently available only in the NocoDB Cloud version, Plus and above plans.</Callout>
1316

1417
<center>
1518
<iframe width="560" height="315" src="https://www.youtube.com/embed/V20tQDkbkvU?si=7EL1IppfR7V9LRBF&start=13" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen ></iframe>
@@ -24,18 +27,16 @@ NocoDB currently supports two types of actions for the Button Field:
2427
6. Configure the button **action** settings as needed. This depends on the action you want the button to perform
2528
- **Open URL**: Use the formula editor to create dynamic URLs.
2629
- **Run Webhook**: Select a webhook from the dropdown OR create a new webhook by clicking on the `+` icon.
30+
- **Run Script**: Select a script from the dropdown.
2731
7. Click on the `Save Field` button.
2832

2933
### Button URL
30-
![image](/img/v2/fields/types/button-url.png)
34+
![image](/img/v2/fields/types/button/open-url.png)
3135

3236
### Button Webhook
33-
![image](/img/v2/fields/types/button-webhook.png)
37+
![image](/img/v2/fields/types/button/run-webhook.png)
3438

35-
:::info
36-
- For "Run Webhook" action, a webhook of specific trigger type must be created in the `Webhooks` section. You can use the same webhook for multiple Button fields.
37-
- "Run Webhook" action will be disabled in shared views and shared base.
38-
:::
39+
<Callout type="note">For the **"Run Webhook"** action, a webhook with the required trigger type must first be created in the **Webhooks** section. The same webhook can be reused across multiple Button fields. Please note that the **"Run Webhook"** action is not available in shared views or shared bases.</Callout>
3940

4041
#### Edit Webhook
4142
To edit a webhook, click on the `Edit` icon next to the webhook name in the Button field settings. This will open the webhook settings modal, where you can edit the webhook URL, method, headers, and payload. Click on the `Save changes` button to save the changes.
@@ -50,8 +51,7 @@ Created webhook can be accessed by using the [Webhook](/docs/product-docs/automa
5051
- [Edit webhook](/docs/product-docs/automation/webhook/actions-on-webhook#edit-webhook)
5152
- [Delete webhook](/docs/product-docs/automation/webhook/actions-on-webhook#delete-webhook)
5253

53-
<Callout type="note">
54-
- Deleting a webhook will remove it from all Button fields that are using it.
55-
- Deleting a Button field will not delete the webhook associated with it.
56-
- Same Webhook can be used across multiple Button fields.
57-
</Callout>
54+
<Callout type="note">Deleting a webhook will remove it from all Button fields that reference it, whereas deleting a Button field will not affect the associated webhook. A single webhook can also be reused across multiple Button fields.</Callout>
55+
56+
### Button Script
57+
![image](/img/v2/fields/types/button/run-script.png)
212 KB
Loading
182 KB
Loading
187 KB
Loading

0 commit comments

Comments
 (0)