Understanding Webhooks

Anne Ramey
Platform Admins

While bridges are a way of form developers to access, use, and display data, webhooks are a different part of the integration picture. They allow Platform admins to have a platform event, such as user creation, user addition onto a team, form creation, or submission sumbit, to reach out to another system and pass that system information. This is intended to be used to allow these events to trigger platform workflows, but they can be used for other integration purposes as well if necessary.

The Basics

Webhooks send information to a specified URL when an event happens. The information provided depends on the event.

Webhook Events

The Kinetic Platform provides the following webhook events:

Level Type Event
Space Space Login Failure
Space User Login
Space User Logout
Space User Created
Space User Updated
Space User Deleted
Space User Membership Change
Space Team Restored
Space Team Created
Space Team Updated
Space Team Deleted
Space Team Membership Change
Space Datastore Form Restored
Space Datastore Form Created
Space Datastore Form Updated
Space Datastore Form Deleted
Space Datastore Submission Deleted
Space Datastore Submission Created
Space Datastore Submission Updated
Space Datastore Submission Saved
Space Datastore Submission Submitted
Kapp Form Restored
Kapp Form Created
Kapp Form Updated
Kapp Form Deleted
Kapp Submission Closed
Kapp Submission Deleted
Kapp Submission Created
Kapp Submission Updated
Kapp Submission Saved
Kapp Submission Submitted

And any of these events can be set up in one or many webhooks. You may need many webhooks for one event, because you may want a filter on a particular event, to make one thing happen in one case and something else happen in another.

WebhookExample

You may also have one or many events that don't have any actions for any particular space or kapp. This is ok too, depending on what your workflow requirements are.

Webhook Jobs

Webhook jobs are instances of webhook events. These record the time of the event, the URL sent to, and the actual data sent.

WebhookJob

This can be very helpful when trying to figure out what exactly was sent where out of the front end of the platform.

Workflow Runs

As you can see in the webhook job details above, the response content indicates a run number. This webhook is pointing at the workflow engine for the platform and triggered a run, or an instance of execution of built workflow. This is the most common use for platform webhooks.