Workflows / Github / push

Github Push Notification to Slack & Email

Use the Github integration by MagicBell to setup a workflow when push 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 push 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 push:

integration.github.push

Example workflow

Notify the team when code is pushed to the main branch. Include commit details and a link to the comparison.

{
  "key": "integration.github.push",
  "steps": [
    {
      "command": "broadcast",
      "input": {
        "action_url": "{{payload.compare}}",
        "content": "{{payload.pusher.name}} pushed to {{payload.ref}}: {{payload.head_commit.message}}",
        "overrides": {
          "providers": {
            "slack": {}
          }
        },
        "recipients": [
          {
            "external_id": "engineering-team"
          }
        ],
        "title": "Push to {{payload.repository.full_name}}"
      }
    }
  ]
}

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.push","steps":[{"command":"broadcast","input":{"action_url":"{{payload.compare}}","content":"{{payload.pusher.name}} pushed to {{payload.ref}}: {{payload.head_commit.message}}","overrides":{"providers":{"slack":{}}},"recipients":[{"external_id":"engineering-team"}],"title":"Push to {{payload.repository.full_name}}"}}]}'

Event payload

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

{
  "after": "def456abc789012345678901234567890xyz012",
  "base_ref": null,
  "before": "abc123def456789012345678901234567890abcd",
  "commits": [
    {
      "added": [
        "src/security/patch.go"
      ],
      "author": {
        "email": "john@example.com",
        "name": "John Dev",
        "username": "john-dev"
      },
      "committer": {
        "email": "john@example.com",
        "name": "John Dev",
        "username": "john-dev"
      },
      "distinct": true,
      "id": "def456abc789012345678901234567890xyz012",
      "message": "Fix critical security vulnerability\n\nPatches CVE-2025-1234 by adding input validation.",
      "modified": [
        "src/auth/handler.go",
        "src/auth/validator.go"
      ],
      "removed": [],
      "timestamp": "2025-01-15T15:30:00Z",
      "tree_id": "tree123abc456def789012345678901234567890",
      "url": "https://github.com/acme/project/commit/def456abc789012345678901234567890xyz012"
    }
  ],
  "compare": "https://github.com/acme/project/compare/abc123...def456",
  "created": false,
  "deleted": false,
  "forced": false,
  "head_commit": {
    "added": [
      "src/security/patch.go"
    ],
    "author": {
      "email": "john@example.com",
      "name": "John Dev",
      "username": "john-dev"
    },
    "committer": {
      "email": "john@example.com",
      "name": "John Dev",
      "username": "john-dev"
    },
    "distinct": true,
    "id": "def456abc789012345678901234567890xyz012",
    "message": "Fix critical security vulnerability\n\nPatches CVE-2025-1234 by adding input validation.",
    "modified": [
      "src/auth/handler.go",
      "src/auth/validator.go"
    ],
    "removed": [],
    "timestamp": "2025-01-15T15:30:00Z",
    "tree_id": "tree123abc456def789012345678901234567890",
    "url": "https://github.com/acme/project/commit/def456abc789012345678901234567890xyz012"
  },
  "organization": {
    "avatar_url": "https://avatars.githubusercontent.com/u/111111",
    "description": "Building great software",
    "id": 111111,
    "login": "acme"
  },
  "pusher": {
    "email": "john@example.com",
    "name": "john-dev"
  },
  "ref": "refs/heads/main",
  "repository": {
    "default_branch": "main",
    "description": "A sample project",
    "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/u/234567",
    "html_url": "https://github.com/john-dev",
    "id": 234567,
    "login": "john-dev",
    "node_id": "MDQ6VXNlcjIzNDU2Nw==",
    "type": "User"
  }
}
View all Github workflows →