Skip to main content
Kinetic Community

Webhooks

Overview

Configure and maintain Webhooks for Forms.

List of Webhooks

All webhooks are listed on the initial page. Click the pencil icon to edit.

Create/Edit Webhooks

Creating a new webhook (+Add Webhook button) or editing a webhook (drop-down arrow and select Edit) lead you to the following console.

Webhook Name. descriptive text that appears in the list.

Type. limited to Submission or Form. Will track changes to these two objects (see Events)

Event - selects the action on the submission that will fire the webhook.

Submission - Closed, Created, Deleted, Saved, Submitted, and Updated.

Form - Created, Deleted, and Updated

          Note on the events. Most of these events can happen once and only once to a submission. The only exception is "Updated". Be cautious when creating an "Updated" webhook. It *is* possible to create an infinite loop by putting a handler in an update tree that updates that submission. 

Filter - Further define when the webhook should fire.

URL - Restful URL for the webhook. Example is for Kinetic Task

Only one webhook can be edited at a time.

Remove Webhook

Select the Remove option from the down arrow for the webhook you want to remove. A dialog will ask you to confirm.

Only one webhook can be removed at a time.

Webhook Example

The following is an example of a webhook specifically for Kinetic Task.

Before you can call task trees with a webhook, you need to configure Kinetic Task with the correct source. The source is defined for a Space, so you will need the Space Slug, and a User with the correct configuration (Space Admin, or a configuration that has the correct permissions).

Task Webhook URL

In order to call into Kinetic Task, Kinetic Request CE must know the URL to send the Webhook request to.  

Kinetic Task Webhook URLs look something like the following:

 

https://task.kineticdata.com/kinetic-task/app/api/v1/run-tree/SOURCE_NAME/SOURCE_GROUP/TREE_NAME

 

If Kinetic Task is running in a development environment, then https may need to be replaced with http or an additional port may be required

  • The SOURCE_NAME will be whatever the Kinetic Task source was named when it was created.  In the case of this guide, the source name is available as a space attribute.  Therefore, the ${space('attribute:Task Source Name')}  variable can be used to automatically apply the value of the variable.

  • The SOURCE_GROUP of a Kinetic Request CE form submission will be in the format SPACE_SLUG > KAPP_SLUG.  The webhook variables ${kapp('slug')} and ${form('slug')} can be used to dynamically set this value based upon the form that is being submitted.  The space character and ‘>’ character need to be encoded in a URL (to %20 and %3E respectively), so the complete SOURCE_GROUP will be something like ${kapp('slug')}%20%3E%20${form('slug')}.

  • The TREE_NAME will be the name of the tree to call.  Typically for Kinetic Request CE form submissions this will be Complete.

 

Some example webhooks:

Submission Submitted:

https:/<yourserver>/kinetic-task/app/api/v1/run-tree/${space('attribute:Task Source Name')}/${kapp('slug')}%20%3E%20${form('slug')}/Submitted

 

Form Created:

https://<yourserver>/kinetic-task/app/api/v1/run-tree/${space('attribute:Task Source Name')}/Kapps%20%3E%20${kapp('slug')}%20%3E%20Forms/Created

 

Topics
Jobs
Track and troubleshoot webhooks here.
Webhooks
Configure and maintain webhooks for the space, users, or teams.
Other