Integrations & Alerts

diid sends notifications when breaking changes are detected, alerting downstream teams who need to review and approve updates.

---

Alert Dispatching

When a new specification version containing breaking changes is published:

1. diid identifies affected downstream consumer projects.
2. Active notification channels configured for those projects or organizations are triggered.
3. Teams receive alerts containing change summaries and approval links.

---

Supported Notification Channels

1. Email

Dispatches email alerts to project members assigned to affected consumer projects. Organizations can configure a primary notification email integration.

2. Slack Webhooks

Posts alert messages to designated Slack channels with affected project names, modified endpoints, and direct approval links.

3. Custom Webhooks

Sends a structured JSON payload to an HTTPS endpoint for integration with internal dashboards or incident management tools.

Example Payload Structure:

{
  "event": "breaking_change.detected",
  "producer": {
    "name": "payment-service",
    "id": "prod_123"
  },
  "consumer": {
    "name": "customer-portal",
    "id": "cons_456"
  },
  "version": "2.0.0",
  "approval_url": "https://app.diid.dev/org/approvals"
}

---

Integration Limits & Security

• Slack & Webhooks: Multiple webhook endpoints can be configured per organization.
• URL Validation: Webhook endpoints must be valid HTTPS URLs.