mirror of https://github.com/nocodb/nocodb
Raju Udava
1 year ago
8 changed files with 299 additions and 7 deletions
@ -1,3 +0,0 @@
|
||||
--- |
||||
title: 'Automation overview' |
||||
--- |
||||
@ -1,3 +1,12 @@
|
||||
--- |
||||
title: 'Webhook overview' |
||||
--- |
||||
|
||||
You can employ webhooks to notify external systems whenever there are additions, updates, or removals of rows within NocoDB. This feature allows you to receive instantaneous notifications for any changes made to your database. NocoDB also offers webhooks for bulk endpoints for creating, updating, or deleting multiple records simultaneously. |
||||
|
||||
Note that, Webhooks currently are specific for associated table. |
||||
|
||||
- [Create Webhook](create-webhook) |
||||
- [Modify Webhook](actions-on-webhook) |
||||
- [Delete Webhook](delete-webhook) |
||||
|
||||
|
||||
@ -1,3 +1,261 @@
|
||||
--- |
||||
title: 'Create webhook' |
||||
--- |
||||
|
||||
## Create Webhook |
||||
|
||||
### Accessing Webhook |
||||
|
||||
1. Click on table for which webhook needs to be configured on the left sidebar |
||||
2. Open `Details` tab in topbar, |
||||
3. Click on `Webhooks` tab |
||||
4. Click `Add New Webhook` |
||||
|
||||
 |
||||
|
||||
### Configuring webhook |
||||
|
||||
1. Webhook Name: Name of the webhook |
||||
2. Event: Select the event for which webhook needs to be triggered |
||||
|
||||
| Trigger | Details | |
||||
|-------------------|-------------------------------------| |
||||
| After Insert | After a single record is inserted | |
||||
| After Update | After a single record is updated | |
||||
| After Delete | After a single record is deleted | |
||||
| After Bulk Insert | After bulk records are inserted | |
||||
| After Bulk Update | After bulk records are updated | |
||||
| After Bulk Delete | After bulk records are deleted | |
||||
|
||||
3. Method & URL: Configure the endpoint to which webhook needs to be triggered. Supported methods are GET, POST, DELETE, PUT, HEAD, PATCH |
||||
|
||||
4. [Optional] Headers & Parameters: Configure Request headers & parameters (if any) |
||||
|
||||
5. [Optional] Condition: Only records meeting the criteria will trigger webhook |
||||
|
||||
6. [Optional] Test: Test webhook (with sample payload) to verify if parameter are configured appropriately |
||||
|
||||
7. Save: Save the webhook |
||||
|
||||
 |
||||
|
||||
### Webhook Response Sample |
||||
|
||||
<Tabs> |
||||
<TabItem value="After Insert" label="After Insert"> |
||||
|
||||
```bash |
||||
{ |
||||
"type": "records.after.insert", |
||||
"id": "9dac1c54-b3be-49a1-a676-af388145fa8c", |
||||
"data": { |
||||
"table_id": "md_xzru7dcqrecc60", |
||||
"table_name": "Film", |
||||
"view_id": "vw_736wrpoas7tr0c", |
||||
"view_name": "Film", |
||||
"rows": [ |
||||
{ |
||||
"FilmId": 1011, |
||||
"Title": "FOO", |
||||
"Language": { |
||||
"LanguageId": 1, |
||||
"Name": "English" |
||||
}, |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
</TabItem> |
||||
<TabItem value="After Update" label="After Update"> |
||||
|
||||
```bash |
||||
{ |
||||
"type": "records.after.update", |
||||
"id": "6a6ebfe4-b0b5-434e-b5d6-5212adbf82fa", |
||||
"data": { |
||||
"table_id": "md_xzru7dcqrecc60", |
||||
"table_name": "Film", |
||||
"view_id": "vw_736wrpoas7tr0c", |
||||
"view_name": "Film", |
||||
"previous_rows": [ |
||||
{ |
||||
"FilmId": 1, |
||||
"Title": "ACADEMY DINOSAUR", |
||||
"Description": "A Epic Drama of a Feminist in The Canadian Rockies", |
||||
"Actor List": [ |
||||
{ |
||||
"ActorId": 10, |
||||
"FirstName": "CHRISTIAN" |
||||
} |
||||
], |
||||
} |
||||
], |
||||
"rows": [ |
||||
{ |
||||
"FilmId": 1, |
||||
"Title": "ACADEMY DINOSAUR (Edited)", |
||||
"Actor List": [ |
||||
{ |
||||
"ActorId": 10, |
||||
"FirstName": "CHRISTIAN" |
||||
} |
||||
], |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
</TabItem> |
||||
<TabItem value="After Delete" label="After Delete"> |
||||
|
||||
```bash |
||||
{ |
||||
"type": "records.after.delete", |
||||
"id": "e593079f-70e5-4965-8944-5ff7aeed005c", |
||||
"data": { |
||||
"table_id": "md_xzru7dcqrecc60", |
||||
"table_name": "Film", |
||||
"view_id": "vw_736wrpoas7tr0c", |
||||
"view_name": "Film", |
||||
"rows": [ |
||||
{ |
||||
"FilmId": 1010, |
||||
"Title": "ALL-EDITED", |
||||
"Language": { |
||||
"LanguageId": 1, |
||||
"Name": "English" |
||||
}, |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
</TabItem> |
||||
<TabItem value="After Bulk Insert" label="After Bulk Insert"> |
||||
|
||||
``` |
||||
{ |
||||
"type": "records.after.bulkInsert", |
||||
"id": "f8397b06-a399-4a3a-b6b0-6d1c0c2f7578", |
||||
"data": { |
||||
"table_id": "md_xzru7dcqrecc60", |
||||
"table_name": "Film", |
||||
"view_id": "vw_3fq2e9q8drkblw", |
||||
"view_name": "GridView", |
||||
"rows_inserted": 2 |
||||
} |
||||
} |
||||
``` |
||||
|
||||
</TabItem> |
||||
<TabItem value="After Bulk Update" label="After Bulk Update"> |
||||
|
||||
``` |
||||
{ |
||||
"type": "records.after.bulkUpdate", |
||||
"id": "e983cea5-8e38-438e-96a0-048751f6830b", |
||||
"data": { |
||||
"table_id": "md_xzru7dcqrecc60", |
||||
"table_name": "Film", |
||||
"view_id": "vw_3fq2e9q8drkblw", |
||||
"view_name": "Sheet-1", |
||||
"previous_rows": [ |
||||
[ |
||||
{ |
||||
"FilmId": 1005, |
||||
"Title": "Q", |
||||
"Language": { |
||||
"LanguageId": 1, |
||||
"Name": "English" |
||||
}, |
||||
}, |
||||
{ |
||||
"FilmId": 1004, |
||||
"Title": "P", |
||||
"Language": { |
||||
"LanguageId": 1, |
||||
"Name": "English" |
||||
} |
||||
} |
||||
] |
||||
], |
||||
"rows": [ |
||||
[ |
||||
{ |
||||
"FilmId": 1005, |
||||
"Title": "Q-EDITED", |
||||
"Language": { |
||||
"LanguageId": 1, |
||||
"Name": "English" |
||||
} |
||||
}, |
||||
{ |
||||
"FilmId": 1004, |
||||
"Title": "P-EDITED", |
||||
"Language": { |
||||
"LanguageId": 1, |
||||
"Name": "English" |
||||
}, |
||||
} |
||||
] |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
</TabItem> |
||||
<TabItem value="After Bulk Delete" label="After Bulk Delete"> |
||||
|
||||
``` |
||||
{ |
||||
"type": "records.after.bulkDelete", |
||||
"id": "e7f1f4e5-7052-4ca2-9355-241ceb836f43", |
||||
"data": { |
||||
"table_id": "md_xzru7dcqrecc60", |
||||
"table_name": "Film", |
||||
"view_id": "vw_3fq2e9q8drkblw", |
||||
"view_name": "Sheet-1", |
||||
"rows": [ |
||||
[ |
||||
{ |
||||
"FilmId": 1022, |
||||
"Title": "x", |
||||
"Language": { |
||||
"LanguageId": 1, |
||||
"Name": "English" |
||||
}, |
||||
}, |
||||
{ |
||||
"FilmId": 1023, |
||||
"Title": "x", |
||||
"Language": { |
||||
"LanguageId": 1, |
||||
"Name": "English" |
||||
}, |
||||
} |
||||
] |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
</TabItem> |
||||
</Tabs>> |
||||
|
||||
|
||||
|
||||
## Call Log |
||||
|
||||
Call Log allows user to check the call history of the hook. By default, it has been disabled. However, it can be configured by using environment variable `NC_AUTOMATION_LOG_LEVEL`. |
||||
|
||||
- `NC_AUTOMATION_LOG_LEVEL=OFF`: No logs will be displayed and no history will be inserted to meta database. |
||||
- `NC_AUTOMATION_LOG_LEVEL=ERROR`: only error logs will be displayed and history of error logs will be inserted to meta database. |
||||
- `NC_AUTOMATION_LOG_LEVEL=ALL`: Both error and success logs will be displayed and history of both types of logs will be inserted to meta database. **This option is only available for Enterprise Edition.** |
||||
|
||||
 |
||||
|
||||
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
--- |
||||
title: 'Delete webhook' |
||||
--- |
||||
@ -1,3 +1,35 @@
|
||||
--- |
||||
title: 'Actions on webhook' |
||||
--- |
||||
|
||||
### Enable/Disable Webhook |
||||
|
||||
To disable a Webhook |
||||
- Open `Webhook` tab to find list of webhooks created |
||||
- Toggle `Activate` button to enable/disable |
||||
|
||||
 |
||||
|
||||
|
||||
### Delete Webhook |
||||
|
||||
To delete a Webhook |
||||
- Open `Webhook` tab to find list of webhooks created |
||||
- Click on `...` actions button associated with the webhook to be deleted |
||||
- Select `Delete` |
||||
|
||||
 |
||||
|
||||
|
||||
### Duplicate Webhook |
||||
|
||||
To duplicate a Webhook |
||||
- Open `Webhook` tab to find list of webhooks created |
||||
- Click on `...` actions button associated with the webhook to be duplicate |
||||
- Select `Duplicate` |
||||
|
||||
 |
||||
|
||||
A copy of the webhook will be created (disabled by default) with a suffix ` - Copy` |
||||
|
||||
|
||||
|
||||
|
After Width: | Height: | Size: 256 KiB |
|
After Width: | Height: | Size: 328 KiB |
Loading…
Reference in new issue