Welcome
Extending product function
Learn how to extend the product.
DevOps Plan REST API developer guide
Webhooks integration package
Webhooks serve as a communication mechanism between systems. A webhook subscribes to DevOps Plan and waits. When events are triggered, DevOps Plan sends information out to the subscriber.

Overview
Learn general information about the product.
Install and deploy DevOps Plan
Find information about installing and deploying DevOps Plan client and server software.
Developing
Learn how to develop schemas by using the DevOps Plan Designer.
Integrating
You can integrate DevOps Plan with other software by adding packages to existing schema.
Extending product function
Learn how to extend the product.
- DevOps Plan REST API developer guide
  - Creating the DevOps Plan REST API SSL Certificate
    DevOps Plan uses SSL to secure access to its user interface and REST APIs. A self signed certificate is provided out of the box, but some proxies and gateways will accept self-signed certificates.
  - Installing SSL certificates
    You can install SSL certificates into the DevOps Plan Helm Chart.
  - Authenticating to the DevOps Plan REST API
    Before making an API call, you must authenticate with the REST API server and use POST to obtain an authorization token.
  - Creating the Personal Access Token for the DevOps Plan REST API
    Youc an use Personal Access Tokens to connect the DevOps Plan REST API to its various REST endpoints.
  - Keycloak integration
    Keycloak provides open source identity and access management and can be integrated with DevOps Plan to help you manage your DevOps Plan users.
  - Repositories and databases
    You can use the DevOps Plan REST API to interact with repositories and databases.
  - Records and record types
    A Record Type describes the structure (meta4tdata) of a Record and is designed by the DevOps Plan Designer.
  - Creating, Deleting, and Retrieving Records
    You can use the DevOps Plan REST API to Create, Delete, and Retrieve records.
  - DevOps Plan REST API queries and result sets
    You can use the DevOps Plan REST API to manage queries and result sets.
  - DevOps Plan REST API troubleshooting
    Troubleshooting for various restrictions and known issues when using the DevOps Plan REST API.
  - Artificial Intelligence integration
    DevOps Plan includes AI integration to help you automate various tasks.
  - Webhooks integration package
    Webhooks serve as a communication mechanism between systems. A webhook subscribes to DevOps Plan and waits. When events are triggered, DevOps Plan sends information out to the subscriber.
    - Installing the Webhooks package
      The Webhooks package allows other systems to receive JSON payloads about DevOps Plan records when certain conditions are met, such as a specific action being executed on a record, or a record changing state.
    - Creating a webhook
      This topic describes how to use DevOps Plan to create a new webhook.
    - Executing webhooks
      Webhooks are automatically executed by DevOps Plan. JSON is sent to the URL of the webhook configuration when an event happens that matches a state or action for the configuration.
  - GitIntegration package
    The GitIntegration package allows the DevOps Plan REST API server to act on GitHub payloads. This allows GitHub events to be connected to records in DevOps Plan as they happen.
- What is DevOps Control?

Webhooks integration package

Webhooks serve as a communication mechanism between systems. A webhook subscribes to DevOps Plan and waits. When events are triggered, DevOps Plan sends information out to the subscriber.

The Webhooks integration package installs into DevOps Plan like any other integration package. The webhooks integration package allows you to:

Create a webhook configuration (WebhookConfig) for a server that wants to be notified of events that occur in DevOps Plan.
This configuration allows the user to select states and/or actions that the server should be notified of.
The user or other users use DevOps Plan as they need. For example, creating, assigning, resolving, duplicating, postponing defects.
Anytime an action or state change occure that matches with what was selected in the configuration, a payload (WebhookData) is created by DevOps Plan.
Periodically, DevOps Plan checks for webhooks, and delivers any pending WebhookData objects to the subscriber or subscribers.

By default, webhooks configurations are refreshed every 15 minutes. WebhookData objects are polled every minute and are deleted upon successful delivery. If the remote system does not catch the webhook, DevOps Plan automatically retries to deliver the payload up to 10 times.

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.