Triggers capability

Overview

This topic explains how to use the triggers integration framework capability.

About triggers

Flag triggers let you turn flags on or off remotely from a third-party application. To learn more about the feature, read Flag triggers.

You can use the trigger capability to generate a unique webhook URL that your service can request to generate a user-defined flag change in LaunchDarkly. By default, the trigger URL contains a globally unique path parameter to provide security in the form of an unguessable URL. To learn more, read Google's Unguessable URLs.

The required documentation field must be a link to documentation outlining how webhooks should be configured in your service.

If the integration offers the option to send test events or webhook requests, the optional testEventNameRegexp field lets you to specify regex to match the expected eventName value. This tells the integration framework not to make any real flag or resource changes associated with matching events.

If your webhooks' request bodies are non-empty, you can specify the optional parser object with one or more of eventName, value, and url. The provided values will flow through LaunchDarkly into the resulting change history messages when your service invokes a trigger in LaunchDarkly.

Here is an example trigger capability:

"trigger": {
      "documentation": "https://example.com/configuring-webhooks",
      "parser": {
        "eventName": "/event",
        "value": "/value",
        "url": "/links/self/href"
      },
    }
COPY

If an integration only has the trigger capability, the word "trigger" will be added to its name in the LaunchDarkly user interface (UI). For this reason, do not include the word "trigger" in the manifest name. For an example, read the generic-trigger manifest.