Create deployment event

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Create deployment event

POST /api/v2/engineering-insights/deployment-events

Create deployment event

cURL

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/engineering-insights/deployment-events \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectKey": "default",
  "environmentKey": "production",
  "applicationKey": "billing-service",
  "version": "a90a8a2",
  "eventType": "started",
  "applicationName": "Billing Service",
  "applicationKind": "server",
  "versionName": "v1.0.0",
  "eventTime": "1706701522000",
  "eventMetadata": {
    "buildSystemVersion": "v1.2.3"
  },
  "deploymentMetadata": {
    "buildNumber": "1234"
  }
}
'

400

{
  "code": "invalid_request",
  "message": "validation failed",
  "errors": [
    {
      "attribute": "projectKey",
      "reason": "must be present"
    }
  ]
}

Authorizations

Authorization · string · header · required

Body

application/json

projectKey · string · required

The project key

Example:

"default"

environmentKey · string · required

The environment key

Example:

"production"

applicationKey · string · required

The application key. This defines the granularity at which you want to view your insights metrics. Typically it is the name of one of the GitHub repositories that you use in this project.

LaunchDarkly automatically creates a new application each time you send a unique application key.

Example:

"billing-service"

version · string · required

The application version. You can set the application version to any string that includes only letters, numbers, periods (.), hyphens (-), or underscores (_).

We recommend setting the application version to at least the first seven characters of the SHA or to the tag of the GitHub commit for this deployment.

Example:

"a90a8a2"

eventType · enum<string> · required

The event type

Available options: started, failed, finished, custom

Example:

"started"

applicationName · string

The application name. This defines how the application is displayed

Example:

"Billing Service"

applicationKind · enum<string>

The kind of application. Default: server

Available options: server, browser, mobile

Example:

"server"

versionName · string

The version name. This defines how the version is displayed

Example:

"v1.0.0"

eventTime · integer<int64>

The time, in Unix milliseconds, when the event occurred. If not included, the time will default to when the event is processed and stored in LaunchDarkly.

Example:

"1706701522000"

eventMetadata · object

A JSON object containing metadata about the event

Show child attributes

Example:

{ "buildSystemVersion": "v1.2.3" }

deploymentMetadata · object

A JSON object containing metadata about the deployment

Show child attributes

Example:

{ "buildNumber": "1234" }

Response

201

Created