Webhooks

Note: Webhooks are available in PRO and PRO+ plans only.

Overview

Webhooks allow you to receive real-time notifications when specific events occur in SyntaxValid. Configure webhook URLs in your project settings to receive POST requests with event payloads.

Events

PR Passed

Triggered when a pull request analysis passes the TrustScore threshold.

{
  "event": "pr_passed",
  "analysis_id": "uuid",
  "project_id": "uuid",
  "trust_score": 85,
  "pr_url": "https://github.com/...",
  "timestamp": "2024-01-01T00:00:00Z"
}

PR Failed

Triggered when a pull request analysis fails the TrustScore threshold.

{
  "event": "pr_failed",
  "analysis_id": "uuid",
  "project_id": "uuid",
  "trust_score": 45,
  "pr_url": "https://github.com/...",
  "failures": ["critical_security", "low_quality"],
  "timestamp": "2024-01-01T00:00:00Z"
}

Gate Blocked

Triggered when a PR gate blocks a merge due to policy violations.

{
  "event": "gate_blocked",
  "analysis_id": "uuid",
  "project_id": "uuid",
  "trust_score": 55,
  "pr_url": "https://github.com/...",
  "blocked_reasons": ["min_trust_not_met", "critical_findings"],
  "timestamp": "2024-01-01T00:00:00Z"
}

Policy Updated

Triggered when a project or workspace policy is updated.

{
  "event": "policy_updated",
  "project_id": "uuid",
  "policy_type": "project",
  "updated_by": "user_id",
  "timestamp": "2024-01-01T00:00:00Z"
}

Configuration

Configure webhooks in your project settings:

Go to your project settings in the dashboard
Navigate to the "Webhooks" section
Add a webhook URL
Select which events you want to receive
Save your configuration

Webhook requests include a signature header for verification. See the API Reference for details.