Skip to content

Getting Started with Versioner

This guide will help you get up and running with Versioner in just a few minutes.

Prerequisites

Before you begin, you'll need:

  • Access to your CI/CD system (GitHub Actions, Jenkins, GitLab CI, etc.)
  • Basic familiarity with REST APIs or command-line tools

Step 1: Create an Account and Get Your API Key

Visit app.versioner.io to create an account. Once logged in, go to the Settings page and create your first API key.

Your API key will look like this: 

sk_mycompany_k1_abc123def456...

Keep Your API Key Secret

Never commit your API key to version control. Store it as a secret in your CI/CD system.

Step 2: Choose Your Integration

Versioner offers three ways to integrate with your deployment workflow:

Native Integrations

Platform-specific plugins that integrate directly with your CI/CD system. Currently supports GitHub Actions with more platforms coming soon.

View Native Integrations Guide

CLI

A universal command-line tool that works with any CI/CD system or deployment environment. Perfect for custom scripts and workflows.

View CLI Documentation

REST API

Direct API access for maximum flexibility and custom integrations. Use any HTTP client or programming language.

View API Documentation

Step 3: Submit Your First Event

Follow the setup instructions in your chosen integration guide to submit your first deployment event. Each guide includes step-by-step instructions and examples.

Once you've submitted an event, you'll receive a JSON response confirming the deployment was tracked successfully.

Step 4: View Your Deployments

Visit your dashboard to see all your environments and deployments in one place.

You're all set!

You've successfully integrated Versioner and tracked your first deployment. Explore the features below to get even more value from Versioner.

Next Steps

Now that you're up and running, explore more features:

Enhance Your Workflow

  • Notifications - Get real-time Slack notifications for deployments and build events
  • Deployment Buttons - Add one-click deployment shortcuts to your workflow
  • Releases - Group multiple product deployments into coordinated releases

Learn Core Concepts

Integration Guides

Need Help?