Setting Webhook

Article Number:040600

Using Webhooks in Kintone, you can automatically send information on specific actions to a specified external service as the actions are carried out in Kintone apps.
For example, you can automatically post the content of a record in a chat service as a new record is added in Kintone. An integration like this can be configured without writing a program.

How Webhooks work

Using a tool that enables you to use Webhooks, you can connect Kintone with various services supported by the tool.
Examples of the tool are Zapier, Microsoft Power Automate, IFTTT and so on.

Figure: How Webhooks work

When a Webhook is configured in a Kintone app, a notification is sent as the following actions are carried out in the app.

  • Adding a record
  • Editing a record
  • Deleting a record
  • Posting a comment
  • Updating the status (When the process management status is updated)

For details on parameters used in Webhook notifications that are triggered by actions in Kintone, refer to Content of Webhook Notifications Triggered by Actions on Kintone.

Example

This section provides an example of using Zapier to configure a Webhook that sends a notification to Gmail as a new record is added in Kintone.

Preparation

As a preparation for configuring a Webhook, carry out the following:

  • Create a Gmail account
  • Create an app in Kintone

When your Gmail account and Kintone app are ready, follow the steps described below.

Configuring a trigger in Zapier

  1. Access Zapier website and sign up.
    If you do not have a Zapier account, create a new one or sign up with your existing account, such as a Google account.

  2. Click MAKE A ZAP on the Zapier website.

  3. Enter a name in the Name your zap input field. Zapier setting screen

  4. On the screen to choose a trigger, enter "Webhook" in the search box and click Webhooks by Zapier. Zapier setting screen

  5. Select Catch Hook for Trigger Event and click CONTINUE. Zapier setting screen

  6. When a Custom Webhook URL is generated, click Copy.
    Paste the copied URL somewhere at hand, such as a text editor. Zapier setting screen

Configuring a Webhook in Kintone

  1. Open the Webhooks setting screen in Kintone.
    Click the app settings button Settings button at the upper right of the "View" screen of an app, select the App Settings tab, and then select Webhooks under Customization and Integration.
    The app settings button

  2. Click the add button Image.

  3. Enter the description of the Webhook to be configured.
    The description you enter here will be displayed in the list of Webhooks. You can enter up to 64 characters. The "New Webhook" screen

  4. In the Webhook Endpoint input field, paste the URL you have copied in step 6 of the "Configuring a trigger in Zapier" section. Delete "https://" at the beginning of the URL you have pasted.
    You can enter up to 1,024 characters in the input field.

  5. In the Events section, specify actions that trigger a Webhook notification.
    In this example, select Record is added.

  6. Select whether to activate this Webhook. By default, the Activate this webhook check box is checked.

  7. Click Save.

  8. Click Back to App Settings on the bottom right side of the Webhooks setting screen.

  9. Click Update App at the upper right of the app settings screen and click OK.

  10. Add a new record in the Kintone app so that you can test the trigger configured in Zapier.

  11. Return to the Zapier website, click CONTINUE, and click Test trigger.
    Zapier website

  12. Check that the test is successful. Then, click CONTINUE.
    If the test fails, try Test trigger several times.
    If the test still fails, check that the URL you copied and pasted in the Webhook Endpoint input field is correct.

Configuring an action in Zapier

  1. When the screen to configure an action is displayed in Zapier, select Gmail. Zapier setting screen

  2. Select Send Email in the Action Event section and click CONTINUE.
    Zapier setting screen

  3. Select a Gmail account and click CONTINUE.
    If you haven't signed in to Gmail, a screen appears for you to sign in to Gmail. Zapier setting screen

  4. Specify the information to be sent to Gmail. Enter the Gmail account of the recipient in the To section, and configure other necessary information including the Subject and Body sections.
    After you complete the setting, click CONTINUE.
    Zapier setting screen

  5. Confirm the setting you have configured and click TEST & CONTINUE.

  6. Check that the notification e-mail is sent to the recipient's Gmail account, and click TURN ON ZAP.

  7. Enable the Zap you configured by turning it on.

Changing the settings of a Webhook in Kintone

This section describes the steps to change Webhook settings afterward in Kintone.

  1. Click the Edit button Edit button for the Webhook whose setting you want to change.
    Changing the setting of Webhooks

  2. Click Back to App Settings on the bottom right side of the Webhooks setting screen.

  3. Click Update App at the upper right of the app settings screen and click OK.

Deleting a Webhook setting in Kintone

This section describes the steps to delete a Webhook setting in Kintone.

  1. Click the Delete button Delete button for the Webhook whose setting you want to delete and click Delete. Deleting a Webhook setting
  2. Click Back to App Settings on the bottom right side of the Webhooks setting screen.
  3. Click Update App at the upper right of the app settings screen and click OK.

Prohibiting the use of Webhooks (Operation by Kintone Users & System Administrators)

If you do not want to allow users to use Webhooks or if you have no plans to use it, you can prohibit the use of Webhooks provided you are a Kintone Users & System Administrator.
When you prohibit the use of Webhooks, the Webhook setting option disappears from the app settings screen of all apps, and users will not be able to add, view, or edit Webhooks. In addition, configured Webhook notifications are no longer sent.

For details on the steps to prohibit the use of Webhooks, refer to Controlling the Sending of Webhook.