Retrieve the records passed by Webhook.
In a Kintone webhook, the notification from Kintone to the webhook contains either the record that caused the notification or the record ID. Retrieve Records Passed by Webhook gets the record contents and makes them available for subsequent actions.
If the operation that caused the notification was ‘Add record’, ‘Edit record’, or ‘Update Process Management Status’, you can get the record out of the box.
For Write Comment, you need to Set Kintone API Token beforehand to set Connection Settings to get the records from the source app.
If you launch a webhook using Invoke Kintone Webhook from the Kintone app customization instead of the standard Kintone webhook launch method, it changes depending on whether you have more than one record.
You cannot get it for Delete record. In this case, an error occurs when the job runs.
In summary, it looks like this:
| Operation that caused the notification | Preset |
|---|---|
| Adding a record | Not required |
| Editing a record | Not required |
| Deleting a record | Not supported |
| Posting a comment | Requires Set Kintone API Token |
| Updating process management statuses | Not required |
| Invoke Kintone Webhook | Setting Kintone API Token is required for multiple records, but it is not required for only 1 record. |
There are no parameters.
| Criteria | Occurrence |
|---|---|
| “When record Row Is Ready” | |
| “When All record Rows Are Ready” |
In the standard Kintone webhooks, a single call will pass a record one line at a time, rather than sending multiple lines at once. So, if you invoke a webhook in the Kintone standard way, you can get one record at most by Retrieve Records Passed by Webhook.
On the other hand, you can use Invoke Kintone Webhook in a Kintone customization created in Customine to pass multiple records together into the Webhook. In this case, Retrieve Records Passed by Webhook can get all the multiple rows passed. When record Row is Ready occurs for each of multiple rows.
If you receive multiple records and the Kintone customizer version is 1.132 (released on May 20, 2021) or later, you must Set Kintone API Token before the Webhook customizer can perform Retrieve Records Passed by Webhook. This is to go and get the Kintone record from the webhook side anew.
If the operation that triggered the notification was “Delete record”, you cannot get it. In this case, an error occurs when the job runs.
If the webhook occurrence criteria was “Write Comment” and the record was deleted between the time the webhook occurred and before the job was launched, you will not get the record. In this case, there is no error, but neither When One Record Ready nor When All Records Ready occurs.
It is not available for scheduled tasks.