> ## Documentation Index
> Fetch the complete documentation index at: https://launchdarkly-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Building a change history event hook integration
> This guide explains how LaunchDarkly partners can use the integration framework to build a change history event hook integration.
> For the complete documentation index, see [llms.txt](/llms.txt). For the full documentation snapshot, see [llms-full.txt](/llms-full.txt).
The LaunchDarkly change history event hook integration used to be called the audit log event hook integration, and still references the `auditLogEventsHook`.
## Overview
This guide explains how LaunchDarkly partners can use the integration framework to build a change history event hook integration. By the end of this guide, you as a LaunchDarkly partner should have the information you need to create a change history events hook integration that LaunchDarkly sends whenever an event happens inside of LaunchDarkly.
Each of these events results in an event being published to LaunchDarkly's change history. You can use this capability to send data to or trigger an event in another service.
## Change history events
Every [resource](/home/account/roles/role-resources#overview) you change in LaunchDarkly generates an associated [change history](/home/releases/change-history) entry. Your integration can transform these events into a format that a POST endpoint can receive. Your team can configure the POST endpoint when they set up the integration.A common use case for the events hook is associating feature flag changes with targeting changes in a specific environment. However, integrations are not limited to that resource only. For a full list of supported resources, read [About resource types and scopes](/home/account/roles/role-resources#about-resource-types-and-scopes).
## Build an integration
To build an integration, make sure you meet the [prerequisites](/integrations/partner-integrations/getting-started#prerequisites). Then follow the steps outlined on the [Getting started](/integrations/partner-integrations/getting-started) page.
The Getting started page explains each of the following steps in detail:
1. [Forking the LaunchDarkly Integration Framework repository](/integrations/partner-integrations/getting-started#fork-the-launchdarkly-integration-framework-repository).
2. [Creating a new directory](/integrations/partner-integrations/getting-started#create-a-new-directory).
3. [Creating an integration manifest](/integrations/partner-integrations/getting-started#create-an-integration-manifest).
* For an example of a completed manifest, read the [Manifest.json example](#manifestjson-example).
4. [Collecting integration configuration data](/integrations/partner-integrations/getting-started#collect-integration-configuration-data).
5. [Defining the integration's capabilities](/integrations/partner-integrations/getting-started#define-the-integrations-capabilities).
* For this integration, define an [`auditLogEventsHook`](/integrations/partner-integrations/audit-log) integration.
* To review the fields for the source payload, read [Sample Context](https://github.com/launchdarkly/integration-framework/tree/main/sample-context) which contains a directory of samples with pre-transformed contexts.
6. [Validating the integration](/integrations/partner-integrations/getting-started#validate-the-integration).
7. [Creating end-user documentation and README](/integrations/partner-integrations/getting-started#create-end-user-documentation-and-readme).
8. [Submitting the integration](/integrations/partner-integrations/getting-started#submit-the-integration). The following sections provide configuration guidance specific to change history events hook integrations.
## Authentication
A change history event hook integration can use either API keys or OAuth for authentication:
* Most integrations use API Keys. If you use API keys, configure them as outlined in the [Collecting integration configuration data step](/integrations/partner-integrations/getting-started#collect-integration-configuration-data) on the Getting started page.
* If you use OAuth, configure it in the root of the manifest. To learn more, read [Defining an integration manifest](/integrations/partner-integrations/manifest) and [Registering a LaunchDarkly OAuth client](/integrations/partner-integrations/oauth-client-registration). For an example OAuth integration, read [AppDynamics Manifest](https://github.com/launchdarkly/integration-framework/blob/main/integrations/appdynamics/manifest.json) under `requiresOAuth`. Integrations with require OAuth can still request additional `formVariables`.The example below uses API Keys.
### Manifest.json example
This example is looking for a flag template file under `templates/flag.json`.The `defaultPolicy` limits the events to flag targeting changes for targeting in all `production` environments of all `projects`:
```json title="JSON" theme={null}
{
"name": "Sample Integration",
"version": "1.0.0",
"overview": "Short one-liner describing your integration.",
"description": "Send flag data to space. Markdown-based description.",
"author": "Example Dot Com",
"supportEmail": "support@example.com",
"links": {
"site": "https://example.com",
"privacyPolicy": "https://example.com/privacy"
},
"categories": ["monitoring"],
"icons": {
"square": "assets/images/square.svg",
"horizontal": "assets/images/horizontal.svg"
},
"requiresOAuth": false,
"formVariables": [{
"key": "apiToken",
"name": "API key",
"type": "string",
"description": "Enter your Example [API key](https://example.com).",
"isSecret": true
},
{
"key": "endpointUrl",
"name": "Example host URL",
"description": "Your Example host URL.",
"type": "enum",
"allowedValues": [
"https://api.example.com",
"https://api.example.eu"
],
"isOptional": true,
"defaultValue": "https://api.example.com"
}
],
"capabilities": {
"auditLogEventsHook": {
"includeErrorResponseBody": false,
"endpoint": {
"url": "{{endpointUrl}}",
"method": "POST",
"headers": [{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{apiToken}}"
}
]
},
"templates": {
"flag": "templates/flag.json"
},
"defaultPolicy": [{
"effect": "allow",
"resources": ["proj/*:env/production:flag/*"],
"actions": [
"updateFlagVariations",
"updateGlobalArchived"
"updateOn",
"updateRules"
"updatePrerequisites",
"updateTargets",
"createFlag",
"deleteFlag"
]
},
{
"effect": "allow",
"resources": ["proj/*:env/production:segment/*"],
"actions": [
"createSegment",
"deleteSegment"
"updateExcluded",
"updateIncluded"
"updateRules"
]
},
]
}
}
}
```
## Default flag template file
You can customize the flag template file as needed to control the rendering of your JSON payload to fit your expected output. If you don't customize the template, then the webhook uses the default template.
Here is the default template:
```json title="JSON" theme={null}
{
"date": "{{timestamp.rfc3339}}",
"event": {
"kind": "{{kind}}",
"action": "{{verbKind}}"
},
"tags": "{{tags}}",
"message": "{{{title.plainText}}}",
"details": "{{{details.plainText}}}",
"comment": "{{#if comment}}{{{comment}}}{{/if}}"
}
```
## Conclusion
This guide describes the process of building a change history event hook integration. To learn more about building your own integrations, read [Building partner integrations](/integrations/partner-integrations).