Workflows / Github / deployment_status

Github deployment_status Event Notification to Slack & Email

Learn how to listen to the deployment_status webhook event from Github to trigger a notification workflow in MagicBell.

Event payload

Sample payload for the deployment_status event.

{
  "action": "created",
  "deployment": {
    "created_at": "2025-01-15T21:00:00Z",
    "creator": {
      "id": 234567,
      "login": "john-dev",
      "type": "User"
    },
    "description": "Deploy v2.1.0 to production",
    "environment": "production",
    "id": 123456789,
    "node_id": "DE_kwDOABC123",
    "ref": "main",
    "sha": "abc123def456789012345678901234567890abcd",
    "task": "deploy",
    "updated_at": "2025-01-15T21:15:00Z"
  },
  "deployment_status": {
    "created_at": "2025-01-15T21:15:00Z",
    "creator": {
      "id": 41898282,
      "login": "github-actions[bot]",
      "type": "Bot"
    },
    "description": "Deployment finished successfully",
    "environment": "production",
    "environment_url": "https://acme-project.com",
    "id": 987654321,
    "log_url": "https://github.com/acme/project/actions/runs/123456789",
    "node_id": "DES_kwDOABC123",
    "state": "success",
    "updated_at": "2025-01-15T21:15:00Z"
  },
  "organization": {
    "avatar_url": "https://avatars.githubusercontent.com/u/111111",
    "description": "Building great software",
    "id": 111111,
    "login": "acme"
  },
  "repository": {
    "default_branch": "main",
    "full_name": "acme/project",
    "html_url": "https://github.com/acme/project",
    "id": 987654321,
    "name": "project",
    "node_id": "MDEwOlJlcG9zaXRvcnk5ODc2NTQzMjE=",
    "owner": {
      "avatar_url": "https://avatars.githubusercontent.com/u/111111",
      "html_url": "https://github.com/acme",
      "id": 111111,
      "login": "acme",
      "type": "Organization"
    },
    "private": false,
    "visibility": "public"
  },
  "sender": {
    "avatar_url": "https://avatars.githubusercontent.com/in/15368",
    "id": 41898282,
    "login": "github-actions[bot]",
    "node_id": "MDM6Qm90NDE4OTgyODI=",
    "type": "Bot"
  }
}

Connect Github to MagicBell to receive events and trigger workflows. This guide uses the MagicBell CLI.

Add the Github integration

Save your Github webhook signing secret in MagicBell. See GitHub webhooks.

magicbell integration save_github \
  --data '{"webhook_signing_secret":"your_secret_here"}'

Copy the ID from the response and use it to build your webhook URL:

https://api.magicbell.com/v2/integrations/github/webhooks/incoming/{id}

Setup the webhook

Setup a webhook in Github with the URL from the last step.
Select the deployment_status event.
If you already have a webhook configured, make sure it includes this event.

Add a workflow

Create a workflow that triggers automatically when Github sends this event. Use liquid templates to access fields in your workflow.

Workflow key

Use this key to trigger the workflow when Github sends a deployment_status event:

integration.github.deployment_status

Filter by action: GitHub sends the event type in the header and the action in the payload body. Use an if condition to filter for the created action:

"if": "payload.action == 'created'"

Example workflow

Track deployment status changes. Notify team on deployment success or failure.

{
  "key": "integration.github.deployment_status.created",
  "steps": [
    {
      "command": "broadcast",
      "input": {
        "action_url": "{{payload.deployment_status.environment_url}}",
        "content": "Deployment to {{payload.deployment.environment}} in {{payload.repository.full_name}} is {{payload.deployment_status.state}}. {{payload.deployment_status.description}}",
        "overrides": {
          "providers": {
            "email": {},
            "slack": {}
          }
        },
        "recipients": [
          {
            "external_id": "devops-team"
          }
        ],
        "title": "Deployment {{payload.deployment_status.state}}: {{payload.deployment.environment}}"
      }
    }
  ]
}

Save with the CLI

Use the MagicBell CLI to save this workflow to your project. You can also use the Workflows API endpoint instead.

magicbell workflow save \
  --data '{"key":"integration.github.deployment_status.created","steps":[{"command":"broadcast","input":{"action_url":"{{payload.deployment_status.environment_url}}","content":"Deployment to {{payload.deployment.environment}} in {{payload.repository.full_name}} is {{payload.deployment_status.state}}. {{payload.deployment_status.description}}","overrides":{"providers":{"email":{},"slack":{}}},"recipients":[{"external_id":"devops-team"}],"title":"Deployment {{payload.deployment_status.state}}: {{payload.deployment.environment}}"}}]}'

Test the workflow

Use the Github CLI to trigger test events and verify your workflow executes correctly.

1. Trigger a test event

Use the GitHub CLI to forward webhook events from your repository to MagicBell:

gh webhook forward \
  --events=deployment_status \
  --url=https://api.magicbell.com/v2/integrations/github/webhooks/incoming/{id}

2. Verify the workflow ran

Check that MagicBell received the event and executed the workflow:

magicbell workflow list_runs --workflow_key integration.github.deployment_status.created

3. Debug issues

If the workflow failed or you need more details, fetch the run to see step-by-step execution:

magicbell workflow fetch_run --run_id {run_id}

Other deployment notification workflows

deployment

Notify team when a deployment is initiated. Track production deployments.

deployment_protection_rule

Notify approvers when deployment protection rules require approval.

View all Github workflows →