Webhooks
Overview
This article introduces Kintone's Webhook feature. Each App in Kintone has a feature to set up outgoing Webhooks. With Webhooks set up, record data can be sent in JSON format to an endpoint of the user's choice.
Webhook Events
Webhooks can be sent at the following trigger events:
Webhook Events | Details |
---|---|
Record is added | A new record is added |
Record is edited | A record is saved after editing |
Record is deleted | A record is deleted |
Comment is posted | A user posts a comment to a record |
Status is changed | A process management status is updated |
Webhook Usages
Webhooks allow data from Kintone to be sent to an endpoint without the use of coding. To set up a Webhook, only the endpoint and the trigger event need to be selected. By sending the Webhook to a service like Zapier , the data can then be used to perform other actions on external services, such as syncing data.
How to Set Up a Webhook
Webhooks can be set up by navigating to the App's settings and clicking on the Webhooks option. Click on the [+] icon to start setting up a Webhook.
For an example of setting up a Webhook with Zapier, refer to the Setting Webhook article on the Kintone Help site.
Data Sent by the Webhook
Data sent with Webhooks are sent in JSON format. For details on the contents of the data, refer to the Content of Webhook Notification Triggered by Actions in Kintone article on the Kintone Help site.
Webhook Execution Logs
Webhook execution logs can be checked in the Webhook settings of the App. For more information, refer to the Checking Webhook Execution Logs article on the Kintone Help site.
Limitations
Webhooks are not sent when the following actions are performed:
- Using Kintone's REST API to perform actions on multiple records in one call
- Importing Excel/CSV files to an App
- Deleting multiple records in bulk