Workflows / Github / pull_request_review_comment

GitHub PR Review Comment Notification to Slack & Email

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

integration.github.pull_request_review_comment

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

Notify PR authors when reviewers leave line comments.

{
  "key": "integration.github.pull_request_review_comment.created",
  "steps": [
    {
      "command": "broadcast",
      "input": {
        "action_url": "{{payload.comment.html_url}}",
        "content": "{{payload.sender.login}} commented on {{payload.comment.path}}: {{payload.comment.body}}",
        "overrides": {
          "providers": {
            "email": {},
            "slack": {}
          }
        },
        "recipients": [
          {
            "external_id": "{{payload.pull_request.user.login}}"
          }
        ],
        "title": "Review comment on PR #{{payload.pull_request.number}}"
      }
    }
  ]
}

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.pull_request_review_comment.created","steps":[{"command":"broadcast","input":{"action_url":"{{payload.comment.html_url}}","content":"{{payload.sender.login}} commented on {{payload.comment.path}}: {{payload.comment.body}}","overrides":{"providers":{"email":{},"slack":{}}},"recipients":[{"external_id":"{{payload.pull_request.user.login}}"}],"title":"Review comment on PR #{{payload.pull_request.number}}"}}]}'

Event payload

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

{
  "action": "created",
  "comment": {
    "author_association": "MEMBER",
    "body": "Consider using structured logging here instead of fmt.Println.",
    "commit_id": "abc123def456789012345678901234567890abcd",
    "created_at": "2025-01-16T16:00:00Z",
    "diff_hunk": "@@ -42,7 +42,7 @@ func handler(w http.ResponseWriter, r *http.Request) {\n-    fmt.Println(\"old code\")\n+    fmt.Println(\"new code\")",
    "html_url": "https://github.com/acme/project/pull/123#discussion_r123456789",
    "id": 123456789,
    "line": 45,
    "node_id": "PRRC_kwDOABC123",
    "original_commit_id": "abc123def456789012345678901234567890abcd",
    "original_line": 45,
    "original_position": 5,
    "original_side": "RIGHT",
    "original_start_line": null,
    "path": "src/api/handler.go",
    "position": 5,
    "pull_request_review_id": 987654321,
    "pull_request_url": "https://api.github.com/repos/acme/project/pulls/123",
    "side": "RIGHT",
    "start_line": null,
    "start_side": null,
    "updated_at": "2025-01-16T16:00:00Z",
    "user": {
      "avatar_url": "https://avatars.githubusercontent.com/u/345678",
      "html_url": "https://github.com/senior-dev",
      "id": 345678,
      "login": "senior-dev",
      "node_id": "MDQ6VXNlcjM0NTY3OA==",
      "type": "User"
    }
  },
  "organization": {
    "avatar_url": "https://avatars.githubusercontent.com/u/111111",
    "description": "Building great software",
    "id": 111111,
    "login": "acme"
  },
  "pull_request": {
    "base": {
      "ref": "main",
      "sha": "789xyz012abc345def678901234567890xyz012"
    },
    "head": {
      "ref": "feature/oauth2-auth",
      "sha": "abc123def456789012345678901234567890abcd"
    },
    "html_url": "https://github.com/acme/project/pull/123",
    "id": 1234567890,
    "node_id": "PR_kwDOABC123",
    "number": 123,
    "state": "open",
    "title": "Add new authentication feature",
    "user": {
      "id": 234567,
      "login": "john-dev",
      "type": "User"
    }
  },
  "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/u/345678",
    "html_url": "https://github.com/senior-dev",
    "id": 345678,
    "login": "senior-dev",
    "node_id": "MDQ6VXNlcjM0NTY3OA==",
    "type": "User"
  }
}

View all Github workflows →