Customize

Invoke Kintone Webhook

Summary

Launch the Kintone Webhook created with Customine.

It can be activated even if the conditions for activating the Webhook are not met.

How to use

Create a customization for the “Kintone Webhook” in Customine Job Runner in advance and generate the job.

You will also need the API key for gusuku. This API key is different from the API token of the Kintone app. The API key for gusuku can be issued and obtained from gusuku Admin.

When the action is executed, it requests the gusuku server to trigger the specified customized Kintone Webhook. Launching the generated job is required, but the job is not generated.

The action will be completed when the activation request is communicated. The action will complete even if the requested Kintone Webhook is still running and not finished. For example, even if the Kintone Webhook takes 5 minutes to process, if the activation request finishes in 1 second, the action will be completed in 1 second.

Kintone does not issue this webhook; it is generated pseudo-randomly by Customine. Therefore, it will not be recorded on the “Webhook log” in the Kintone webhook settings. You can check it instead on Customine’s job history. Conversely, even if the webhook settings are not configured in the Kintone app, it can still be triggered from Customine.

Even if an error occurs within the Kintone Webhook, it will not be displayed on Kintone. There is no error history left in the Kintone Webhook settings. You can check the history and errors on Customine’s job history.

Parameters

Set Scheduled Task Customization, Gusuku API Key, Operation Type, App, Record, and Concurrency.

Scheduled Task Customization

Select the customization of the Kintone Webhook to activate from the list.

Only the customization of Kintone Webhook is displayed, and the customization of Scheduled Tasks is not shown in the list.

Gusuku API Key

Specify the API key for gusuku.

Please note that this is not about the API token on the Kintone app.

Operation Type

Select what kind of operation should be assumed to have been performed from “Add a record”, “Edit a record”, “Change the status of a record”.

“Delete a record” and “Post a comment” are not supported.

App

Set which app the webhook will be notified from.

Usually, select the same app as the target for customization selected in “Kintone Webhook customization.”

Record

Select the record data to send to the webhook.

If multiple records are included, they will be sent together in one go. It is not possible to notify multiple webhooks at once by passing multiple records. The number of records that can be sent at once in a single action is up to 500.

If there are no records selected, an error will occur.

If you omit the selection, the records that the user has open on the screen will be sent. At this time, if the record cannot be determined to be one, it will result in an error.

Concurrency

Selecting “Deny” will not permit concurrent execution of jobs created from the same customization. If a job is running in a state where concurrent execution is “Deny”, trying to start another instance of the same job with “Deny” for concurrent execution will result in an error. If they are different jobs, they can be executed simultaneously.

Selecting “Allow” enables simultaneous execution of the same job.

If different actions and customizations are mixed with “Deny” and “Allow” for the execution of the same job, “Allow” takes precedence and allows concurrent execution.

Also, if you run it as a standard webhook instead of “Invoke Kintone Webhook,” it means you execute it with “Allow” for Concurrency. Therefore, even if you start “Kintone Webhook” with “Deny” for Concurrency, the standard webhook will be executed simultaneously.

Precautions

  • Communication with gusuku’s server will occur, but IP address restrictions are not applied during this connection.

Restrictions

  • The Kintone Webhook that was not created on Customine cannot be launched.

  • “Delete a record” and “Post a comment” are not supported.

  • In the notification content sent by the standard Kintone Webhook, the app name (app.name) and the record title (recordTitle) will be empty strings.

    • For the notification content sent by the standard Kintone Webhook, refer to the “Content of Notifications Sent” section in the Cybozu official help .
  • There are no conditions that are triggered when the Kintone Webhook processing is completed.