Workflows / Github / deployment_protection_rule

GitHub Deployment Approval Notification to Slack

Use the Github integration by MagicBell to setup a workflow when deployment_protection_rule triggers in Github.

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_protection_rule 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.

Workflow key

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

integration.github.deployment_protection_rule

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 requested action:

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

Example workflow

Notify approvers when deployment protection rules require approval.

{
  "key": "integration.github.deployment_protection_rule.requested",
  "steps": [
    {
      "command": "broadcast",
      "input": {
        "action_url": "{{payload.deployment_callback_url}}",
        "content": "A deployment to {{payload.environment}} in {{payload.repository.full_name}} requires approval.",
        "overrides": {
          "providers": {
            "slack": {}
          }
        },
        "recipients": [
          {
            "external_id": "deployment-approvers"
          }
        ],
        "title": "Deployment approval required for {{payload.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_protection_rule.requested","steps":[{"command":"broadcast","input":{"action_url":"{{payload.deployment_callback_url}}","content":"A deployment to {{payload.environment}} in {{payload.repository.full_name}} requires approval.","overrides":{"providers":{"slack":{}}},"recipients":[{"external_id":"deployment-approvers"}],"title":"Deployment approval required for {{payload.environment}}"}}]}'

Event payload

Sample payload for the deployment_protection_rule event. Use liquid templates to access fields in your workflow.

{
  "action": "requested",
  "deployment": {
    "created_at": "2025-01-16T18:00:00Z",
    "creator": {
      "avatar_url": "https://avatars.githubusercontent.com/u/234567?v=4",
      "html_url": "https://github.com/john-dev",
      "id": 234567,
      "login": "john-dev",
      "node_id": "MDQ6VXNlcjIzNDU2Nw==",
      "type": "User"
    },
    "description": "Deploying to production",
    "environment": "production",
    "id": 987654321,
    "node_id": "DE_kwDOABC123",
    "original_environment": "production",
    "payload": {},
    "ref": "main",
    "sha": "abc123def456789012345678901234567890abcd",
    "task": "deploy",
    "updated_at": "2025-01-16T18:00:00Z",
    "url": "https://api.github.com/repos/acme/project/deployments/987654321"
  },
  "deployment_callback_url": "https://api.github.com/repos/acme/project/actions/runs/123456789/deployment_protection_rule",
  "environment": "production",
  "event": "push",
  "organization": {
    "avatar_url": "https://avatars.githubusercontent.com/u/111111?v=4",
    "description": "Building great software",
    "id": 111111,
    "login": "acme",
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjExMTExMQ==",
    "url": "https://api.github.com/orgs/acme"
  },
  "pull_requests": [],
  "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?v=4",
      "html_url": "https://github.com/acme",
      "id": 111111,
      "login": "acme",
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjExMTExMQ==",
      "type": "Organization"
    },
    "private": true,
    "visibility": "private"
  },
  "sender": {
    "avatar_url": "https://avatars.githubusercontent.com/in/15368?v=4",
    "html_url": "https://github.com/apps/github-actions",
    "id": 41898282,
    "login": "github-actions[bot]",
    "node_id": "MDM6Qm90NDE4OTgyODI=",
    "type": "Bot"
  }
}

View all Github workflows →