Setting Up Webhooks

Article Number:040600

By using Webhooks in kintone, you can automatically send information on specific actions to a specified external service as the actions are carried out on kintone apps.
For example, you can have the content of records automatically posted to a chat service when they are added to kintone. An integration like this can be configured without writing a program.
Webhooks are available only for the kintone Standard license plan.

How Webhooks work

Using an integration 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, and IFTTT.

Figure: How Webhooks work

Setting up Webhooks on a kintone app, you can set up notifications for the following actions carried out on 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 on kintone, refer to Content of Webhook Notifications Triggered by Actions on kintone.

Procedure to set up a Webhook

Below is the procedure to set up a Webhook.

  • Set up a trigger using an integration tool (e.g. Zapier)
  • Set up a Webhook on kintone
  • Set up an action using the integration tool

Example

This section provides an example of using Zapier to set up a Webhook that sends a notification to Gmail as a new record is added on kintone.

Preparation

As a preparation for setting up a Webhook, carry out the following:

  • Create a Gmail account
  • Create a kintone app

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

Setting up a trigger on 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 Create Zap on the Zapier website.

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

  4. Select Catch Hook under Event and then click Continue. Zapier settings screen

  5. On the screen that follows, click Continue. Zapier settings screen

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

Next, you will set up a Webhook on kintone. Keep the Zapier website open.

Setting up a Webhook on kintone

  1. Navigate to the Webhooks setting screen on kintone.
    Click the App Settings icon (the gear-shaped icon at the upper right of the "View" screen), select the App Settings tab, and then select Webhooks under Customization and Integration.
    The "App Settings" icon

  2. Click Add Webhook.

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

  4. In the Webhook Endpoint input field, paste the URL you have copied in Step 6 of the "Setting up a trigger on 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. The "New Webhook" screen

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

  6. Select the Activate this webhook check box.
    By default, the check box is selected.

  7. Click Save on the bottom right side of the screen.

  8. Click App Settings in the message displayed at the top of the screen, or click Back to App Settings displayed at the bottom left of the screen.

  9. Click Update App on the upper right side of the screen.

  10. On the confirmation dialog, click Update App.

  11. Add a new record on the kintone app so that you can test the trigger you have set up on Zapier.

  12. Return to the Zapier website and click Test trigger.
    Zapier website

  13. 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.

Setting up an action on Zapier

  1. When the screen to set up an action is displayed in Zapier, select Gmail. Zapier settings screen

  2. Select Send Email under Event and then click Continue.
    Zapier setting screen

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

  4. Specify the information to be sent to the Gmail account.
    Enter the Gmail account of the recipient into the To section, and set up other necessary items including the Subject and Body sections. Then, click Continue.
    Zapier setting screen

  5. Confirm the setting you have set up and click Test & Continue.

  6. Click Publish Zap.

  7. Check that the notification e-mail is sent to the recipient's Gmail account, and click Publish & Turn On.

The Zap is now valid.

Changing the settings of a Webhook in kintone

Webhook settings in kintone can be changed later on. To change a Webhook's settings, follow the steps below.

  1. Click the Edit icon in the far right column of the Webhook for which you want to change the settings.
    Changing the setting of Webhooks

  2. Edit the settings and click Save.

  3. Click App Settings in the message displayed at the top of the screen, or click Back to App Settings displayed at the bottom left of the screen.

  4. Click Update App on the upper right side of the screen.

  5. On the confirmation dialog, click Update App.