Feature Request: API Endpoint & Webhook for Validation Errors
I hope you’re doing well.
I’d like to propose a feature enhancement for Gearset’s API that would greatly improve integration and visibility across systems like Slack, GitHub, and Jira.
Feature Request:
• API Endpoint:
Expose the existing endpoint as part of the Gearset API: https://us.app.gearset.com/api/validation/started/{jobId}/result that returns specific error messages for failed components after a validation attempt.
This would allow us to programmatically retrieve validation outcomes and integrate them into other systems for better tracking and visibility.
Webhook Support (Bonus Feature):
Even better, adding webhook functionality to push validation results directly to external systems (e.g., Slack) would streamline our workflow. This real-time feedback would enhance team awareness and reduce the time spent manually checking validation statuses.
JSON response today that the website uses:
{
"Result": {
"Succeeded": false,
"Message": "Validation failed with (4/5 component(s) validated)",
"Successes": [
{
"Fullname": "complaintDetail",
"Message": null,
"Filename": "unpackaged/lwc/complaintDetail",
"LineNumber": 0,
"ComponentType": "LightningComponentBundle"
},
{
"Fullname": "DSCustomLayoutCS",
"Message": null,
"Filename": "unpackaged/flexipages/DSCustomLayoutCS.flexipage",
"LineNumber": 0,
"ComponentType": "FlexiPage"
}
],
"Failures": [
{
"Fullname": "OfflineConversionTrackingAfterInsertTrigger",
"Message": "insufficient access rights on cross-reference id",
"Filename": "unpackaged/flows/OfflineConversionTrackingAfterInsertTrigger.flow",
"LineNumber": 0,
"ComponentType": "Flow"
}
],
"PassedTests": [],
"FailedTests": [],
"ApiVersion": 62
}
}
Benefits:
• Improved Automation: Seamlessly integrate validation results into existing CI/CD pipelines.
• Increased Visibility: Push validation errors directly to team communication channels like Slack for real-time alerts.
• Enhanced Traceability: Link validation outcomes to related Jira tickets and GitHub pull requests for better context and tracking.
We believe this feature would significantly enhance Gearset’s integration capabilities and help teams streamline their workflows.
Looking forward to hearing your thoughts!
Thanks,
Tommy Wilson for David W.
