Sign in

v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB
Integration audit log subscriptions

Create audit log subscription

Create an audit log subscription.<br /><br />For each subscription, you must specify the set of resources you wish to subscribe to audit log notifications for. You can describe these resources using a custom role policy. To learn more, read Custom role concepts.

post/api/v2/integrations/{integrationKey}

Path parameters

integrationKeystring string required

The integration key

The integration key

Request body

namestring required

A human-friendly name for your audit log subscription.

onboolean

Whether or not you want your subscription to actively send events.

tagsstring[]

An array of tags for this subscription.

configobject required

The unique set of fields required to configure an audit log subscription integration of this type. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure.

urlstring

Slack webhook receiver URL. Only necessary for legacy Slack webhook integrations.

apiKeystring

Datadog API key. Only necessary for legacy Datadog webhook integrations.

Example request

{
  "name": "Example audit log subscription.",
  "statements": [
    {
      "resources": [
        "proj/*:env/*:flag/*;testing-tag"
      ],
      "actions": [
        "*"
      ],
      "effect": "allow"
    }
  ],
  "tags": [
    "testing-tag"
  ],
  "config": {
    "optional": "an optional property",
    "required": "the required property",
    "url": "https://example.com"
  }
}

Response

Integration response

_linksobject

The location and content type of related resources

_idstring

The ID for this integration audit log subscription

kindstring

The type of integration

namestring

A human-friendly name for the integration

configobject

Details on configuration for an integration of this type. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> for a full list of fields for each integration.

onboolean

Whether the integration is currently active

tagsstring[]

An array of tags for this integration

urlstring

Slack webhook receiver URL. Only used for legacy Slack webhook integrations.

apiKeystring

Datadog API key. Only used for legacy Datadog webhook integrations.

Example response

{
  "_id": "1234a56b7c89d012345e678f",
  "kind": "datadog",
  "name": "Example Datadog integration",
  "statements": [
    {
      "resources": [
        "proj/*:env/*;qa_*:/flag/*"
      ],
      "actions": [
        "*"
      ],
      "effect": "allow"
    }
  ],
  "on": true,
  "tags": [
    "testing"
  ],
  "_access": {
    "denied": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ],
    "allowed": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ]
  }
}