Sign in

v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB
Insights deployments (beta)

Create deployment event

Create deployment event

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

Request body

projectKeystring required

The project key

environmentKeystring required

The environment key

applicationKeystring 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.<br/><br/>LaunchDarkly automatically creates a new application each time you send a unique application key.

applicationNamestring

The application name. This defines how the application is displayed

applicationKind'server' | 'browser' | 'mobile'

The kind of application. Default: <code>server</code>

versionstring required

The application version. You can set the application version to any string that includes only letters, numbers, periods (<code>.</code>), hyphens (<code>-</code>), or underscores (<code>_</code>).<br/><br/>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.

versionNamestring

The version name. This defines how the version is displayed

eventType'started' | 'failed' | 'finished' | 'custom' required

The event type

eventTimeinteger
eventMetadataobject

A JSON object containing metadata about the event

deploymentMetadataobject

A JSON object containing metadata about the deployment

Example request

{
  "projectKey": "default",
  "environmentKey": "production",
  "applicationKey": "billing-service",
  "applicationName": "Billing Service",
  "applicationKind": "server",
  "version": "a90a8a2",
  "versionName": "v1.0.0",
  "eventType": "started",
  "eventMetadata": {
    "buildSystemVersion": "v1.2.3"
  },
  "deploymentMetadata": {
    "buildNumber": "1234"
  }
}

Response

Created