Create deployment event

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

Create deployment event

Request

This endpoint expects an object.
projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

applicationKeystringRequired

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.

versionstringRequired

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.

eventTypeenumRequired
Allowed values: startedfailedfinishedcustom

The event type

applicationNamestringOptional

The application name. This defines how the application is displayed

applicationKindenumOptional
Allowed values: serverbrowsermobile

The kind of application. Default: server

versionNamestringOptional

The version name. This defines how the version is displayed

eventTimelongOptional

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.

eventMetadatamap from strings to anyOptional

A JSON object containing metadata about the event

deploymentMetadatamap from strings to anyOptional

A JSON object containing metadata about the deployment

Errors

Built with