Automation Menu

Webhooks

4min

One of the key benefits of using webhooks in Kubeark is their ability to automate tasks and processes, such as sending notifications or updating databases in response to specific events. Additionally, the platform's webhooks provide users with an easy-to-use interface for managing and creating webhooks, without the need for extensive programming knowledge.

Overview

Kubeark makes use of webhooks as a means of enabling real-time communication between its platform and other applications. These webhooks allow for the automatic triggering of events, such as the creation or updating of templates and deployments, as well as the integration of the platform's functionality with external REST-based systems.

Users can manage and create webhooks through the Kubeark Webhooks page, where they can view detailed information such as the User_IDDescriptionAction, and Payload for each webhook.  

  • User_ID: a unique identifier for the webhook
  • Description: short text that describes the webhook's purpose
  • Action: the event that triggers the webhook
  • Payload: data that is being sent when the webhook is triggered

Overall, Kubeark's utilization of webhooks allows for seamless integration with external systems and enables real-time communication, automating tasks and processes, providing users with a more efficient and flexible way to manage their deployments and templates.

How does it work?

Creating a webhook in the Kubeark Platform is a simple process that can be done by clicking on the Create Webhookbutton on the Webhooks page.

Once you have clicked on the button, you will be prompted to provide the following attributes:

  1. Action Type: This is a drop-down list that contains four available actions: 
  • Create template: Allows you to create a new template based on your config/payload.
  • Update template: Allows you to update an existing template based on your config/payload.
  • Deploy template: Allows you to deploy an existing template based on your config/payload.
  • Update deployment: Allows you to update an existing deployment based on your config/payload.

2. User_ID: This is a unique identifier for the webhook.

3. Description: A short text that describes the purpose of the webhook.

4. Payload: The data that is sent when the webhook is triggered. Please see below an example:

JSON


Once you have provided all the required information, click on the "Save" button to create the webhook. The webhook will now be listed on the Webhooks page and you can view, edit or delete it as needed.