Deployments API

Deployment Tracking Using Raygun

Use Raygun’s deployment tracking capabilities to be alerted to issues caused by bad releases.

When new deployments are made, Raygun keeps a watchful eye on your application for issues that have been created. You’ll be able to see exactly when a problem was introduced, with all the information needed to fix things before they cause you bigger problems. When you’re shipping software your customers rely on, Raygun is your safety net, should things not go as expected.

deployment tracking

Tracking Deployments Alongside Errors

With Deployment Tracking enabled, Raygun lets you view your deployments alongside your exisitng Crash Reporting error chart. This allows you to quickly determine how particular deployments are performing, with respect to errors in your application.

Deployments API Endpoint

POST https://app.raygun.io/deployments

Data

The body of the message should be a JSON string with the following structure:

{
    apiKey: string,
    version: string,
    ownerName: string,
    emailAddress: string,
    comment: string,
    scmIdentifier: string,
    scmType: string,
    createdAt: ISO 8601 datetime
}

apiKey

The API Key of your Raygun Application

version

The version of your Application that this deployment is releasing. Should be the same as the version string you use in your Raygun error reports.

ownerName

Optional The name of the person who is creating this deployment. Ideally should be a Raygun User.

emailAddress

Optional The email address of the person who is creating this deployment. Ideally should be a Raygun User's email address.

comment

The deployment notes. This will be parsed as Markdown.

scmIdentifier

The commit that this deployment was built off. If this is a Git commit hash and you have a source control integration set up, we will attempt to gather information about the changes made since your last deployment.

scmType

The source control system you use, used to gather up changes since your last deployment.

Valid types

  • Github (defaults to Github)
  • GitLab
  • BitBucket

createdAt

Optional The date and time this deployment was released in ISO 8601 form. If this is omitted, we use the current time.

Authentication

This endpoint can be accessed via HTTP Basic Auth or Token Authentication.

For Basic Auth, use your normal Raygun user credentials (email address and password).

For Token Auth, generate an External Authentication Token on the Raygun User Settings Page and add an authToken query string parameter to the URL. For instance, if your API token is 123ABC, the URL would be https://app.raygun.io/deployments?authToken=123ABC.

Documentation missing?

If we don't have documentation about your desired topic, send us a message and we'll create it for you.