Configure Automated Notifications in Moonshadow

Set up rules to automatically notify your team via Slack, email, or webhook when specific events occur in your connected integrations.

Moonshadow notification rules let you define when and how your team gets alerted about events from connected integrations. You can create rules that match specific event types, apply filters, and deliver notifications through Slack, email, or custom webhooks.

Create a Notification Rule

A notification rule connects event triggers to delivery channels. When an event matches the rule conditions, Moonshadow sends the notification through every configured channel.

curl -X POST https://api.moonshadow.dev/v1/notifications/rules \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": "ws_1234567890abcdef",
    "name": "Critical Slack Alerts",
    "enabled": true,
    "triggers": [
      {
        "event_type": "event.created",
        "filters": {
          "integration_type": "github",
          "payload.action": "opened",
          "payload.pull_request.draft": false
        }
      }
    ],
    "channels": [
      {
        "type": "slack",
        "config": {
          "channel": "#engineering-alerts"
        }
      },
      {
        "type": "email",
        "config": {
          "recipients": ["[e-mail]"]
        }
      }
    ]
  }'

Response:

{
  "id": "nr_abc123def456",
  "workspace_id": "ws_1234567890abcdef",
  "name": "Critical Slack Alerts",
  "enabled": true,
  "triggers": [
    {
      "event_type": "event.created",
      "filters": {
        "integration_type": "github",
        "payload.action": "opened",
        "payload.pull_request.draft": false
      }
    }
  ],
  "channels": [
    {
      "type": "slack",
      "config": {
        "channel": "#engineering-alerts"
      }
    },
    {
      "type": "email",
      "config": {
        "recipients": ["[e-mail]"]
      }
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

workspace_id · string · required

The workspace that owns this notification rule.

name · string · required

A human-readable name for the rule.

triggers · array · required

List of trigger conditions. Each trigger specifies an event type and optional filters.

channels · array · required

List of delivery channels. Moonshadow sends to all channels when triggers match.

Trigger Conditions

Triggers define which events activate the notification rule. Each trigger has an event_type and optional filters that narrow down matching events.

Event Types

You can trigger on any event type that occurs in your workspace:

• event.created - any event from a connected integration
• automation.completed - an automation workflow finished
• integration.connected - a new integration was added
• integration.disconnected - an integration was removed
• user.invited - a new user was invited to the workspace

Filters

Filters use dot notation to match values inside the event payload. Only events that satisfy all filters trigger the notification.

Filter Example	Matches
integration_type: "github"	Events from GitHub only
payload.action: "opened"	Payload action field equals “opened”
payload.pull_request.draft: false	Non-draft pull requests
payload.severity: ["high", "critical"]	Severity is high or critical

Filters support exact matching, arrays for OR conditions, and nested dot notation. Use them to avoid noisy notifications.

Delivery Channels

Each rule can deliver to one or more channels. Moonshadow supports Slack, email, and webhook channels.

Slack

Sends a formatted message to a Slack channel. Requires a connected Slack integration.

{
  "type": "slack",
  "config": {
    "channel": "#engineering-alerts",
    "mention": "@here"
  }
}

Email

Sends an email to one or more recipients.

{
  "type": "email",
  "config": {
    "recipients": ["[e-mail]", "[e-mail]"],
    "subject": "Moonshadow Alert: {{event.type}}"
  }
}

Webhook

POSTs the event payload to a custom URL.

{
  "type": "webhook",
  "config": {
    "url": "https://your-app.com/alerts",
    "headers": {
      "X-Custom-Header": "value"
    }
  }
}

Muting and Snoozing

You can temporarily disable a rule without deleting it. This is useful during maintenance windows or when a service is down.

Disable a Rule

curl -X PATCH https://api.moonshadow.dev/v1/notifications/rules/nr_abc123def456 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Snooze a Rule

Snoozing disables a rule for a fixed duration and re-enables it automatically.

curl -X POST https://api.moonshadow.dev/v1/notifications/rules/nr_abc123def456/snooze \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "duration_minutes": 60,
    "reason": "Deploying critical fix"
  }'

Snoozed rules show a countdown in the dashboard. You can cancel a snooze early by re-enabling the rule manually.

Full Example: GitHub Pull Request Alerts

This complete example creates a rule that alerts the team when a non-draft pull request is opened in GitHub.

API_KEY="YOUR_API_KEY"
WORKSPACE_ID="ws_1234567890abcdef"

curl -X POST https://api.moonshadow.dev/v1/notifications/rules \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"workspace_id\": \"$WORKSPACE_ID\",
    \"name\": \"GitHub PR Opened Alerts\",
    \"enabled\": true,
    \"triggers\": [
      {
        \"event_type\": \"event.created\",
        \"filters\": {
          \"integration_type\": \"github\",
          \"payload.action\": \"opened\",
          \"payload.pull_request.draft\": false
        }
      }
    ],
    \"channels\": [
      {
        \"type\": \"slack\",
        \"config\": {
          \"channel\": \"#pull-requests\",
          \"mention\": \"@here\"
        }
      },
      {
        \"type\": \"email\",
        \"config\": {
          \"recipients\": [\"[e-mail]\"],
          \"subject\": \"New PR: {{payload.pull_request.title}}\"
        }
      }
    ]
  }"

Notification rules apply at the workspace level. Every event in the workspace is evaluated against all enabled rules, so keep filter specificity high to prevent redundant notifications.

Next Steps

• First Integration

  Connect Slack or another integration to enable Slack notifications

• Webhooks

  Build custom delivery pipelines with webhook channels

• API Reference

  Explore all notification rule endpoints and parameters