GitHub Action

Integrate GitHub Actions with

The GitHub Action flips the pattern of integration with our platform—from passively collecting the user activity in your repo used for deriving Insights, to actively pushing the events defining your development workflow to the platform.

If you’re already comfortable with using GitHub Actions or just prefer having granular control of the events collected by the platform, we provide our own Action for you to drop into your existing workflows on GitHub. By explicitly defining when our Action runs within your GitHub Actions workflow, you can send Events to the platform at the points in your existing workflow that make the most sense. This additional level of control also makes it possible to fine-tune the metrics sent to our platform, improving the accuracy of the Insights we derive for complex collaborative processes.

Configuring GitHub Actions

Before you can configure our GitHub Action as part of your GitHub workflow, you will need credentials.

For more information about the Deployment Events and Change Events that the platform can receive and use for deriving Insights about your development lifecycle, have a look at our Insights Events documentation.

Usage Examples

The examples below demonstrate some of the ways our GitHub Action can be used to track the milestones of your workflow.


The value defined by the event_name and event_action keys should always be written in lowercase letters, for example:

  • event_name: deployment
  • event_action: "success"
  • event_action: failure

Remember that quoting YAML string values is optional when the string doesn’t contain special characters.

Please note that these examples don’t include the steps you might use to deploy your application; rather, they demonstrate how you can integrate our GitHub Action in the context of your existing workflows.