Webhooks (Advanced)
Written By Team BugSmash
Last updated About 1 month ago
Why it’s useful
For engineering teams needing total control or custom dashboards, webhooks deliver real-time event data from BugSmash to your systems.
How it works
1. Go to Workspace Settings → Integrations → Webhooks.
2. Click Add Webhook and enter your Endpoint URL.
3. Choose the trigger events, for which you want to get the webhook events:
Event: new_comment
Called when a new comment is added in any of your projects.
Example{
"event": "new_comment",
"comment_id": "8449bd15-cd8e-4904-aa7a-005f70fc4f7b",
"comment": "new feedback",
"comment_number": "1",
"status": "Active",
"comment_by_name": "John Doe",
"comment_by_email": "john@example.com",
"priority": "High",
"assigned_to_name": "Jane Smith",
"assigned_to_email": "jane@example.com",
"is_private": false,
"attachment_file_url": "https://api.example.com/api/v2/files/...",
"comment_screenshot_file_url": "https://api.example.com/api/v2/files/...",
"project_id": "8449bd15-cd8e-4904-aa7a-005f70fc4f7b",
"project_name": "Project Name",
"project_type": "pdf",
"project_version_id": "8449bd15-cd8e-4904-aa7a-005f70fc4f7b",
"project_version": "V1",
"created_at": "2026-01-14T15:00:00.000000Z",
"updated_at": "2026-01-14T15:00:00.000000Z"
}Event: comment_updated
Called when any property of a comment is updated. Like Assigned to or Priority etc.
{
"event": "comment_updated",
"comment_id": "8449bd15-cd8e-4904-aa7a-005f70fc4f7b",
"comment": "The updated comment text",
"comment_number": "1",
"priority": "Critical",
"is_private": true,
"updated_by_name": "John Doe",
"updated_by_email": "john@example.com",
"assigned_to_name": "Jane Smith",
"assigned_to_email": "jane@example.com",
"project_id": "b5e3fca2-21a4-4ce4-a809-c3bb316f1066",
"project_name": "Project Name",
"project_type": "pdf",
"project_version_id": "8449bd15-cd8e-4904-aa7a-005f70fc4f7b",
"project_version": "V1",
"updated_at": "2026-01-14T15:00:00.000000Z"
}Event: new_reply_on_comment
Called when a reply is added in a comment thread
{
"event": "new_reply_on_comment",
"comment_id": "8449bd15-cd8e-4904-aa7a-005f70fc4f7b",
"comment_number": "1",
"reply_text": "The reply text content",
"reply_by_name": "Jane Smith",
"reply_by_email": "jane@example.com",
"project_id": "b5e3fca2-21a4-4ce4-a809-c3bb316f1066",
"project_name": "Project Name",
"project_type": "pdf",
"project_version_id": "8449bd15-cd8e-4904-aa7a-005f70fc4f7b",
"project_version": "V1",
"created_at": "2026-01-14T15:00:00.000000Z",
"updated_at": "2026-01-14T15:00:00.000000Z"
}Event: status_changed
Called when the status of a comment/feedback is changed from active to resolved or resolved to active
{
"event": "status_changed",
"comment_id": "8449bd15-cd8e-4904-aa7a-005f70fc4f7b",
"comment_number": "1",
"status": "Resolved",
"updated_by_name": "John Doe",
"updated_by_email": "john@example.com",
"project_id": "b5e3fca2-21a4-4ce4-a809-c3bb316f1066",
"project_name": "Project Name",
"project_type": "pdf",
"project_version_id": "8449bd15-cd8e-4904-aa7a-005f70fc4f7b",
"project_version": "V1",
"updated_at": "2026-01-14T15:00:00.000000Z"
}
4. Click Connect
5. Handle the incoming payload on your server and process the feedback data accordingly.
Example
> The dev team’s internal dashboard uses webhooks to show live feedback per sprint, auto-grouped by project and status.
Tips
- Verify webhook key for security.
- Use message queues (e.g., RabbitMQ, Kafka) if handling high volumes.
- Don’t expose public endpoints without authentication.