Webhooks

Overview

This topic explains how to create and use webhooks in LaunchDarkly.

LaunchDarkly’s webhooks allow you to build your own integrations that subscribe to changes in LaunchDarkly. When something changes, like when a feature flag is updated, or when an account member is invited to LaunchDarkly, LaunchDarkly sends an HTTP POST payload to the webhook’s configured URL.

Use webhooks to update external issue trackers, update support tickets, notify customers of new feature rollouts, and more.

You can also use the REST API: Webhooks

Create a webhook

To create a webhook:

1. Click the gear icon in the left sidenav to view Organization settings.
2. Click Integrations and search for or navigate to the “Webhooks” integration.
3. Click Add integration. The “Create a webhook” panel appears.
4. (Optional) Give the webhook a human-readable Name.
5. Enter an absolute URL.
6. If you want the webhook to be signed, check the Sign this webhook checkbox. To learn more, read Sign a webhook.
7. Add a policy if you want to select and filter the events sent to the webhook. To learn more, read Add a policy filter.
8. After reading the Terms and Conditions, check the I have read and agree to the Integration Terms and Conditions checkbox.
9. Click Save settings.

You can also use the REST API: Create a webhook

Sign a webhook

When creating a webhook, you can define an optional secret. If defined, the webhook POST request will include an X-LD-Signature header, whose value will contain an HMAC SHA256 hex digest of the webhook payload, using the secret as the key.

Compute the signature of the payload using the same shared secret in your code to verify that the webhook was triggered by LaunchDarkly. You can use the auto-generated secret, or supply your own when creating or editing a webhook.

Add a policy filter

LaunchDarkly sends all flag change events in the production environment to a webhook by default. To customize the events LaunchDarkly sends to a webhook, use the policy editor in the webhook creation panel.

For example, to receive events only when a change is made to one of your production feature flags, add one of the following policies to your webhook:

1
[
2
  {
3
    "effect": "allow",
4
    "actions": ["*"],
5
    "resources": ["proj/*:env/production:flag/*"]
6
  }
7
]

To learn more about creating a policy, read Example roles and policies.

You can also use the REST API: Update webhook

Payload format

The webhook payload format is identical to the entry format for the change history. Read our REST API Documentation for an example payload.

Retries

If LaunchDarkly receives a non-2xx response to a webhook POST, it attempts to retry the delivery once. Webhook delivery is not guaranteed, and integrations built on webhooks should be tolerant of delivery failures.

Disable a webhook

You can temporarily disable a webhook by hitting the On/Off switch on the Integrations page.

Test a webhook

If you need to generate a test URL, we recommend using Pipedream or Insomnia.

Deleting webhooks

You can delete a webhook when you no longer need it.

To delete a webhook:

1. Click the gear icon in the left sidenav to view Organization settings.
2. Click Integrations and search for or navigate to the “Webhooks” integration.
3. Click the expand arrow next to the Add integration button.

4. Click the pencil icon next to the webhook you want to delete. The “Edit webhook” panel appears.
5. Click Delete webhook. A confirmation dialog appears.
6. Click Delete.

You can also use the REST API: Delete webhook