Notifications

CodeCord provides a flexible notification system that keeps your server informed about important repository events.

GitHub Event Notifications

Supported Events

Pull Requests

• Pull request opened
• Pull request closed
• Pull request merged
• Pull request reopened

Issues

• Issue opened
• Issue closed
• Issue reopened (if enabled, pings assigned users with linked accounts)
• Issue assigned/unassigned (if enabled, pings newly assigned users with linked accounts)

Actions

• Workflow Run started
• Workflow Run completed
• Workflow Job started
• Workflow Job completed

Repository Events

• Repository starred/unstarred
• Fork created
• Release published
• Security and vulnerability alerts

Event Configuration

Each event type can be configured with:

• Target channel for notifications
• Role mentions
• Custom message format
• Enable/disable status

Personal GitHub Notifications

When you link your GitHub account, you can receive personal notifications for:

• Being assigned to review a pull request
• Being reminded about stale pull requests where you are an assigned reviewer
• Being assigned to an Issue

Notification Configuration

Channel Settings

• Different github events can go to different channels
• Keep discussions organized by topic
• Separate critical notifications from general updates

Role Configuration

• Mention specific roles for different events
• Configure which events should ping team members
• Set up custom notification rules

Message Formatting

• Customize the format and embed of the notifications messages
• Configure what information to include
• Customize notification appearance
• Use the visual message builder to create custom embeds for each notification
• Preview your notifications in real-time

Notifiation Message Customization System

Visual Builder

Our visual message embed builder allows you to create custom notification formats with:

• Drag-and-drop interface for field arrangement
• Group related information in rows
• Customize field labels and values
• Preview changes in real-time with sample data
• Support for inline and block field layouts

Available Variables

Templates can include various event-specific variables such as:

• Repository information (name, URL)
• Event details (title, description, status)
• User information (author, reviewers, assignees)
• Statistics (files changed, duration, counts, additions, deletions)

Embed Guidelines

• Group related fields together (e.g., Pull Request title with description)
• Place important information at the top
• Give larger fields their own row
• Use consistent formatting across similar notifications
• Keep templates concise and readable
• Consider mobile users when designing layouts
• Don’t include what you may consider sensitive information

Data Handling

• We process webhook data in real-time but do not store payload contents
• Only configuration settings and notification embed configurations are stored
• You control what information appears in notifications
• Configure webhooks carefully to avoid sending sensitive data

Implementation Guide

Channel Organization

• Use dedicated channels for different notification types
• Most adopters prefer using the repository counter channels for notifications
• Set up role mentions thoughtfully to avoid notification fatigue
• Consider channel permissions for sensitive notifications

Setup Recommendations

• Start with minimal notifications and add as needed
• Review and adjust notification settings periodically
• Use role mentions sparingly to prevent notification overload

Security Considerations

• Ensure notification channels have appropriate permissions
• Be mindful of sensitive information in notifications
• Notifications will never include any code
• Configure private repository notifications carefully
• We process but do not store webhook payload contents
• Only notification settings and templates are retained

Usage Tips

• Set up different notification channels for important events
• Configure quiet hours for role mentions in the CodeCord dashboard