Webhooks

Introduction

Kianda Developer includes a webhooks function. A webhook or web callback allows information to be pushed from Kianda to your applications in real time when process instances are created, deleted or updated. This provides an efficient way to execute event reactions, thereby eliminating the need to continuously poll for data. The information that is posted includes variables like the process name and instance ID.

The Kianda webhooks function allows you to configure URLs that can respond to process instance creation, deletion and update events. When these events happen, the webhook will then make a HTTP request to your application/service, including variables like the process instance name, querying the provided URL, so your application can be updated.

Note: Callback has a timeout of 10 seconds.

How to get started

You must have an Administrator or Developer role see Users & Groups for more details on roles. Then to get started with webhooks:

  1. Navigate to Administration in the left-hand side menu, and click on Developer. This will bring you to the Developer resources page.

    Developer resources page

    Widget view

  2. Click on Webhooks to create a process instance callback.

  3. The Instance Callback URLs dialog box appears.

    Webhooks

  4. Use the slider to turn on the relevant callback:

    • Enable Created Callback - this will enable a URL callback every time a process instance is updated. This results in a HTTP GET request with parameters instanceID={instanceID}, processName={processName} and eventType=created being issued to the given URL.
    • Enable Updated Callback - this will enable a URL callback every time a process instance is updated. This results in a HTTP GET request with parameters instanceID={instanceID}, processName={processName} and eventType=updated being issued to the given URL.
    • Enable Deleted Callback - this will enable a URL callback every time a process instance is deleted. This results in a HTTP GET request with parameters instanceID={instanceID}, processName={processName} and eventType=deleted being issued to the given URL.
  5. In each case type in the URL to respond to process instance create, update and deleted events. Note that in each case, you can add more than one function, but use only one URL per line, using enter/return key to move to the next line. This will allow you to update multiple services using the callback operation above.

  6. Click on the Help button Help button for clarification.

    Callback helptext

  7. Click on OK when done or click on Close at any stage to close the dialog box.

What’s next Idea icon

To continue with low-code development, you can view Templating basics. If you would like to learn more about ‘no-code versus low-code’ in general, see What is no-code? and What is low-code?.

To return to the main Low-code development page, click on the link.