Github check_run Event Notification to Slack & Email
Learn how to listen to the check_run webhook event from Github to trigger a notification workflow in MagicBell.
Event payload
Sample payload for the check_run event.
{
"action": "completed",
"check_run": {
"app": {
"id": 15368,
"name": "GitHub Actions",
"node_id": "MDM6QXBwMTUzNjg=",
"slug": "github-actions"
},
"check_suite": {
"conclusion": "failure",
"head_branch": "feature/new-api",
"head_sha": "abc123def456789012345678901234567890abcd",
"id": 987654321,
"node_id": "CS_kwDOABC123",
"status": "completed"
},
"completed_at": "2025-01-15T14:15:00Z",
"conclusion": "failure",
"details_url": "https://github.com/acme/project/actions/runs/987654321",
"external_id": "",
"head_sha": "abc123def456789012345678901234567890abcd",
"html_url": "https://github.com/acme/project/runs/123456789",
"id": 123456789,
"name": "build-and-test",
"node_id": "CR_kwDOABC123",
"output": {
"annotations_count": 3,
"annotations_url": "https://api.github.com/repos/acme/project/check-runs/123456789/annotations",
"summary": "Tests failed: 3 errors found in src/auth/handler_test.go",
"text": null,
"title": "Build failed"
},
"pull_requests": [
{
"base": {
"ref": "main",
"sha": "789xyz012abc345def678901234567890xyz012"
},
"head": {
"ref": "feature/new-api",
"sha": "abc123def456789012345678901234567890abcd"
},
"id": 123456789,
"number": 123,
"url": "https://api.github.com/repos/acme/project/pulls/123"
}
],
"started_at": "2025-01-15T14:00:00Z",
"status": "completed",
"url": "https://api.github.com/repos/acme/project/check-runs/123456789"
},
"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 check_run 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 check_run event:
integration.github.check_runFilter 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 completed action:
"if": "payload.action == 'completed'"Example workflow
Notify developers when CI checks fail. Send via Slack with details about the failure.
{
"key": "integration.github.check_run",
"steps": [
{
"if": "payload.action == 'completed' \u0026\u0026 payload.check_run.conclusion == 'failure'",
"command": "broadcast",
"input": {
"action_url": "{{payload.check_run.html_url}}",
"content": "Check run failed on {{payload.check_run.check_suite.head_branch}} in {{payload.repository.full_name}}. {{payload.check_run.output.summary}}",
"overrides": {
"providers": {
"slack": {}
}
},
"recipients": [
{
"external_id": "engineering-team"
}
],
"title": "CI Failed: {{payload.check_run.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.check_run","steps":[{"if":"payload.action == 'completed' \u0026\u0026 payload.check_run.conclusion == 'failure'","command":"broadcast","input":{"action_url":"{{payload.check_run.html_url}}","content":"Check run failed on {{payload.check_run.check_suite.head_branch}} in {{payload.repository.full_name}}. {{payload.check_run.output.summary}}","overrides":{"providers":{"slack":{}}},"recipients":[{"external_id":"engineering-team"}],"title":"CI Failed: {{payload.check_run.name}}"}}]}'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=check_run \
--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.check_run3. 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}