Skip to content

Commit eb8d3cc

Browse files
dstaladstala
committed
docs: field webhook triggers
Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
1 parent e34a05f commit eb8d3cc

File tree

1 file changed

+195
-4
lines changed

1 file changed

+195
-4
lines changed

‎content/docs/automation/webhook/create-webhook.mdx‎

Lines changed: 195 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,27 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
2323
1. **Name the webhook** - Give a clear & descriptive name.
2424

2525
2. Select the **Trigger Source** type :
26+
<Callout type="info">Trigger Source type **View** and **Field** are only available in the cloud & self-hosted enterprise plans.</Callout>
2627

2728
- **Record** - Triggers when a record is inserted, updated, or deleted, or for all actions if “Send me everything” is selected.
2829
- **View** - Triggers when a view is created, updated, or deleted, or for all actions if “Send me everything” is selected.
30+
- **Field** - Triggers when a field is created, updated, or deleted, or for all actions if “Send me everything” is selected.
2931
- **Manual Trigger / Button Trigger** - Trigger runs when a user manually clicks a webhook configured button.
3032

3133
3. Select **Trigger Event** type : Refer table [here](#trigger-source-and-event) for available events for each source
3234
4. [Optional] **Trigger based on condition** : details [here](#webhook-with-conditions)
33-
> Conditions are only applicable for Record trigger source events
35+
<Callout type="note">Conditions are only applicable for Record trigger source events</Callout>
3436
- Specify the condition for which webhook should be triggered
3537
- You can select multiple conditions
3638
- If no condition is selected, webhook will be triggered for all records
3739

3840
5. [Optional] **Trigger for updates in specific fields** : details [here](#webhook-on-field-changes-)
39-
> This is only applicable for Record `After Update` event.
41+
<Callout type="note">This is only applicable for Record `After Update` event.</Callout>
4042
- Select the fields for which webhook should be triggered.
4143
- If no field is selected, any field update will trigger webhook
4244

4345
6. [Optional] **Trigger only when specific form submitted**: details [here](#webhook-on-specific-form-submission-)
44-
> This is only applicable for Record `After Insert` event.
46+
<Callout type="note">This is only applicable for Record `After Insert` event.</Callout>
4547
- Select the form for which webhook should be triggered.
4648

4749
7. **Webhook Action** : Select the action to be performed when webhook is triggered. Action can be one of the following:
@@ -61,6 +63,8 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
6163

6264
Webhooks in NocoDB can be configured based on the source of the trigger and the type of event. The table below outlines the available combinations:
6365

66+
<Callout type="info">Trigger Source type **View** and **Field** are only available in the cloud & self-hosted enterprise plans.</Callout>
67+
6468
| **Trigger Source** | **Trigger Event** | **Description** |
6569
|--------------------|--------------------|------------------------------------------------------------|
6670
| Record | Send Me Everything | Triggers on any record insert, update, or delete operation |
@@ -71,9 +75,13 @@ Webhooks in NocoDB can be configured based on the source of the trigger and the
7175
| | After Create | Triggers after a view is created |
7276
| | After Update | Triggers after a view is updated |
7377
| | After Delete | Triggers after a view is deleted |
78+
| Field | Send Me Everything | Triggers on any field create, update, or delete operation |
79+
| | After Create | Triggers after a field is created |
80+
| | After Update | Triggers after a field is updated |
81+
| | After Delete | Triggers after a field is deleted |
7482
| Button Trigger | — | Triggers when a button field is clicked |
7583

76-
> For more details on using **Button Trigger** webhooks with the **Button** field, see the [Button field documentation](/docs/product-docs/fields/field-types/custom-types/button).
84+
For more details on using **Button Trigger** webhooks with the **Button** field, see the [Button field documentation](/docs/product-docs/fields/field-types/custom-types/button).
7785

7886

7987
### Webhook with conditions
@@ -387,6 +395,189 @@ Use `{{ json event }}` to access the event data. Sample response is as follows
387395
</Tab>
388396
</Tabs>
389397

398+
#### Field trigger
399+
<Tabs items={['After Create', 'After Update', 'After Delete']}>
400+
<Tab value="After Create">
401+
```bash
402+
{
403+
"type": "field.after.create",
404+
"id": "2e97d383-1d94-48d7-8214-3a7fd013c801",
405+
"version": "v3",
406+
"data": {
407+
"table_id": "ma334932sjnwp3e",
408+
"table_name": "AllTypes",
409+
"fields": [
410+
{
411+
"id": "cqxah2exzt1lxbz",
412+
"table_id": "ma334932sjnwp3e",
413+
"title": "Financial Quarter",
414+
"type": "SingleSelect",
415+
"default_value": "'Q1'",
416+
"system": false,
417+
"options": {
418+
"choices": [
419+
{
420+
"title": "Q1",
421+
"color": "#cfdffe",
422+
"id": "shs9oq0ddo1ecnq"
423+
},
424+
{
425+
"title": "Q2",
426+
"color": "#d0f1fd",
427+
"id": "s65lkpm9822w8t7"
428+
},
429+
{
430+
"title": "Q3",
431+
"color": "#c2f5e8",
432+
"id": "swg8jzbgh99t36f"
433+
},
434+
{
435+
"title": "Q4",
436+
"color": "#ffdaf6",
437+
"id": "s9duce07erlzq5n"
438+
}
439+
]
440+
},
441+
"description": "Specifies quarter in which this task is required to be included."
442+
}
443+
]
444+
}
445+
}
446+
```
447+
</Tab>
448+
<Tab value="After Update">
449+
```bash
450+
{
451+
"type": "field.after.update",
452+
"id": "6a4c9326-0bdc-4920-9089-6340394340b4",
453+
"version": "v3",
454+
"data": {
455+
"table_id": "ma334932sjnwp3e",
456+
"table_name": "AllTypes",
457+
"previous_fields": [
458+
{
459+
"id": "cqxah2exzt1lxbz",
460+
"table_id": "ma334932sjnwp3e",
461+
"title": "Financial Quarter",
462+
"type": "SingleSelect",
463+
"default_value": "'Q1'",
464+
"system": false,
465+
"options": {
466+
"choices": [
467+
{
468+
"title": "Q1",
469+
"color": "#cfdffe",
470+
"id": "shs9oq0ddo1ecnq"
471+
},
472+
{
473+
"title": "Q2",
474+
"color": "#d0f1fd",
475+
"id": "s65lkpm9822w8t7"
476+
},
477+
{
478+
"title": "Q3",
479+
"color": "#c2f5e8",
480+
"id": "swg8jzbgh99t36f"
481+
},
482+
{
483+
"title": "Q4",
484+
"color": "#ffdaf6",
485+
"id": "s9duce07erlzq5n"
486+
}
487+
]
488+
},
489+
"description": "Specifies quarter in which this task is required to be included."
490+
}
491+
],
492+
"fields": [
493+
{
494+
"id": "cqxah2exzt1lxbz",
495+
"table_id": "ma334932sjnwp3e",
496+
"title": "Financial Quarter",
497+
"type": "SingleSelect",
498+
"default_value": "'Quarter-1'",
499+
"system": false,
500+
"options": {
501+
"choices": [
502+
{
503+
"title": "Quarter-1",
504+
"color": "#cfdffe",
505+
"id": "shs9oq0ddo1ecnq"
506+
},
507+
{
508+
"title": "Quarter-2",
509+
"color": "#d0f1fd",
510+
"id": "s65lkpm9822w8t7"
511+
},
512+
{
513+
"title": "Quarter-3",
514+
"color": "#c2f5e8",
515+
"id": "swg8jzbgh99t36f"
516+
},
517+
{
518+
"title": "Quarter-4",
519+
"color": "#ffdaf6",
520+
"id": "s9duce07erlzq5n"
521+
}
522+
]
523+
},
524+
"description": "Specifies quarter in which this task is required to be included."
525+
}
526+
]
527+
}
528+
}
529+
```
530+
</Tab>
531+
<Tab value="After Delete">
532+
```bash
533+
{
534+
"type": "field.after.delete",
535+
"id": "8b2b293f-a926-4280-b116-493ac197ba10",
536+
"version": "v3",
537+
"data": {
538+
"table_id": "ma334932sjnwp3e",
539+
"table_name": "AllTypes",
540+
"fields": [
541+
{
542+
"id": "cqxah2exzt1lxbz",
543+
"table_id": "ma334932sjnwp3e",
544+
"title": "Financial Quarter",
545+
"type": "SingleSelect",
546+
"default_value": "'Quarter-1'",
547+
"system": false,
548+
"options": {
549+
"choices": [
550+
{
551+
"title": "Quarter-1",
552+
"color": "#cfdffe",
553+
"id": "shs9oq0ddo1ecnq"
554+
},
555+
{
556+
"title": "Quarter-2",
557+
"color": "#d0f1fd",
558+
"id": "s65lkpm9822w8t7"
559+
},
560+
{
561+
"title": "Quarter-3",
562+
"color": "#c2f5e8",
563+
"id": "swg8jzbgh99t36f"
564+
},
565+
{
566+
"title": "Quarter-4",
567+
"color": "#ffdaf6",
568+
"id": "s9duce07erlzq5n"
569+
}
570+
]
571+
},
572+
"description": "Specifies quarter in which this task is required to be included."
573+
}
574+
]
575+
}
576+
}
577+
```
578+
</Tab>
579+
</Tabs>
580+
390581
#### Manual trigger
391582

392583
<Tabs items={["Manual Trigger"]}>

0 commit comments

Comments
 (0)