Skip to main content


Deployment API

As described in the 'How it works' document, two preparations are required to connect with the deployment API; 1) Make sure your deployment tooling is listening for the Github deployment event. 2) Update the deployment status by API after execution is complete. This document will show how you can connect with the mainstream deployment tools.

GitHub Action

Listening for an event

GitHub Action provides the on syntax to define the type of activity that will trigger a workflow run, and it supports the deployment event.


And you can use the if conditional to run a job when an environment is met. You can use context to access the deployment environment.

runs-on: ubuntu-latest
if: ${{ github.event.deployment.environment === 'production' }}

Update the deployment status

The third-party plugin, chrnorm/deployment-status, provides that a GitHub action updates the status of deployments as part of your GitHub CI workflows.

runs-on: ubuntu-latest
name: Update the deployment status
uses: chrnorm/deployment-status@releases/v1
token: "${{ github.token }}"
deployment_id: ${{ }}
description: Finish to deploy successfully.
state: "success"

You can reference this example for integrating with GitHub action.

Drone CI

Listening for an event

Drone CI provides the trigger field to limit pipeline execution based on the drone event type, supporting the promote event.

- promote

And you can access the DRONE_DEPLOY_TO environment by the environment if you need the conditional step.

Update the deployment status

The third-party plugin, cedrichopf/drone-status, provides that a Drone CI updates the status of deployments as part of your CI pipelines.

- name: Update the deployment status
image: cedrichopf/drone-status
from_secret: GITHUB_TOKEN
context: deploy
state: success
description: Finish to deploy successfully.


Listening for an event

The trigger type has to be the webhook type to listen to an event, and the constraints verify repository and environment to determine if triggered or not.

Spinnaker Webhook Trigger

Update the deployment status

Spinnaker provides a simple way to add a custom stage to call API instead of extending through codes. Spinnaker can typically make API calls as part of a pipeline by adding a custom stage.

To create a custom webhook, we have to add the configuration to the orca-local.yml file, located in $HOME/.hal/default/profiles. And the custom stage has a few variables, owner, repo, deployment_id, description, and state, for updating the deployment status dynamically. You can set up the variables for your project.

Custom Stage
- label: Update Deployment status
type: updateDeploymentStatus
enabled: true
description: Update the deployment status.
method: POST
url:${ parameterValues['owner'] }/${ parameterValues['repo'] }/deployments/${ parameterValues['deployment_id'] }/statuses
# Replace with your GitHub token.
- application/json
payload: |-
"description": "${parameterValues['description']}",
"state": "${parameterValues['state']}",
"log_url": "http://localhost:9000/#/applications/${execution.application}/executions/details/${}"
- label: GitHub Owner
name: owner
type: string
- label: GitHub Repo
name: repo
type: string
- lable: Deployment ID
name: deployment_id
type: string
- label: Description
name: description
type: string
- label: State
name: state
type: string
description: The state can be one of "queued", "in_progress", "success", "failure"

You can reference the spinnaker demo for integrating with Spinnaker.

Internal Deployment Tooling

GitHub provides a well-organized document to guide to build an internal deployment tooling to deploy on your servers with the Deployment API.



Step 1: Create App

Firstly, we have to create Slack App. You should click the Create App button and fill out inputs.

Step 2: Configure Permissions

After creating App, we move to the OAuth & Permissions page and set up the redirect URLs and Bot Token scopeson this page. Firstly, you should add a new redirect URL with the GITPLOY_SERVER_PROTO://GITPLOY_SERVER_HOST/slack/signin format; secondly, add chat:write scope into the Bot Token scopes.

Slack Bot Token Sceops

Step 3: Run Server With App Credentials

To enable Slack integration, you have to set up these environments when you run the server: GITPLOY_SLACK_CLIENT_ID and GITPLOY_SLACK_CLIENT_SECRET. You can get these credentials from App Credentials section of Basic Information page.