Test webhooks manually
Summarize
Summary of Test Webhooks Manually
This guide provides instructions for manually testing webhooks across various tools such as GitLab, Rally, Split.io, Jira, Bitbucket, and Argo CD in cases where connection issues arise. Admin privileges are required for each respective tool, along with specific permissions in DevOps Change.
Show less
Key Features
- GitLab: Navigate to Settings > Webhooks, select the project, and test webhooks for code and orchestration events. Correct configuration is confirmed with a success message.
- Rally: No direct testing option; check webhook activity under My Settings > System Administration > Extensions > Webhooks, ensuring the webhook is active.
- Split.io: Inspect integration settings to verify correct configuration and active status of the ServiceNow DevOps application. No direct testing option available.
- Jira: Check webhooks under Administration > System for Server or Settings > System for Cloud. Ensure webhooks are enabled and correctly configured.
- Bitbucket: Access Repository settings > Workflow > Webhooks to verify the corresponding webhook is active and correctly configured.
- Argo CD: No direct testing option; refer to the manual configuration guide for webhooks.
Key Outcomes
By following these procedures, ServiceNow customers can effectively troubleshoot webhook connectivity issues, confirm correct configurations, and ensure seamless integration with their DevOps tools. This proactive approach helps maintain workflow efficiency within DevOps Change Velocity.
For tools including GitLab, Rally, Split.io, Jira, Bitbucket, and Argo CD, you have to test webhooks manually if there is any issue with the connection.
GitLab
- GitLab: GitLab admin privileges
- DevOps Change: sn_devops.admin or sn_devops.tool_owner
- Navigate to GitLab and select the project for which you want to test webhooks.
- Navigate to .
When your project is configured in DevOps Change Velocity, webhooks are created for that project in GitLab. These webhooks are available under Project Hooks.
For each project, two webhooks are created. One is for code events and the other for orchestration events.
- To test a webhook, select Test and select Push events from the list.Note:You can test for other events as well, for example Tag push events.
- If the webhook is configured correctly, you’ll receive a success message. For example:
- If the webhook is configured incorrectly, you’ll receive an error message. For example:To fix a webhook, you can try the following options:
- Reconfigure the webhooks by selecting Configure from the project record page in DevOps Change Velocity. This reconfigures all the existing webhooks for the project.
-
Select Edit for the webhook and verify if the toolId is correct in the URL field. Verify if the Secret token is correct.
You can find the correct values in the tool record page in DevOps Change Velocity.
- If the webhook is configured correctly, you’ll receive a success message. For example:
For detailed information about webhooks in GitLab, see Webhooks.
Rally
- Rally: Rally admin privileges
- DevOps Change: sn_devops.admin or sn_devops.tool_owner
-
From your Rally instance, navigate to .
Check if there’s a corresponding webhook created for your DevOps Change instance, and that it’s Active.
- Reconfigure the webhook by selecting Configure from the project record page in DevOps Change Velocity. This reconfigures the existing webhook for the project.
For detailed information about webhooks in Rally, see Manage Webhooks.
Split.io
- Split.io: Split.io admin privileges
- DevOps Change: sn_devops.admin or sn_devops.tool_owner
-
From your Split.io instance, navigate to . Select the Configured tab, and select Edit for the ServiceNow DevOps application.
Check if the ServiceNow DevOps application is configured correctly in Split.io. For details on configuring, see Enable integration with ServiceNow DevOps in Split tool.
- Check if the status of the ServiceNow DevOps application is Active.
- Reconfigure the webhook by selecting Configure from the tool record page in DevOps Change Velocity. This reconfigures the existing webhook for the Split.io tool.
You can also refer to ServiceNow integration with Split.io.
Jira
- Jira: Jira admin privileges
- DevOps Change: sn_devops.admin or sn_devops.tool_owner
-
Navigate to:
- For Jira Server navigate to .
- For Jira Cloud instance, navigate to .
Check if there’s a corresponding webhook created for your DevOps Change instance.
- Select Edit for the webhook.
- Check if the status is Enabled.
- Check if the Tool ID in the URL field is correct. The Tool ID is the value after ?toolId=.
- Check if the secret token in the URL field is correct. Token value is at the end of the URL, after token=.
You can find the correct values of the Tool ID and Secret token in the tool record page in DevOps Change Velocity.
For detailed information about webhooks in Jira, see Webhooks.
- Reconfigure the webhook by selecting Configure from the tool record page in DevOps Change Velocity. This reconfigures the existing webhook for the Jira tool.Note:
If you have connected your Jira tool using OAuth 2.0 based authentication, the webhooks are created for the OAuth 2.0 integration app in Jira when you configure automatically, whereas if you have connected using basic authentication, the webhooks are created for all your projects in Jira. If you choose to configure the webhooks manually for a Jira tool created using OAuth 2.0 based authentication, a duplicate webhook may get created.
Bitbucket
- Bitbucket: Bitbucket admin privileges
- DevOps Change: sn_devops.admin or sn_devops.tool_owner
-
Navigate to Bitbucket and select the repository for which you want to test webhooks. Navigate to .
Check if there’s a corresponding webhook created for your DevOps Change instance.
- Select Edit for the webhook.
- Check if the status is Active.
- Check if the Tool ID in the URL field is correct. The Tool ID is the value after /event/.
- Check if the secret token in the URL field is correct. Token value is at the end of the URL, after token=.
You can find the correct values of the Tool ID and Secret token in the tool record page in DevOps Change Velocity.
For detailed information about webhooks in Bitbucket, see Manage webhooks.
- Reconfigure the webhook by selecting Configure from the tool record page in DevOps Change Velocity. This reconfigures the existing webhook for the Bitbucket tool.
Argo CD
- Argo CD: Argo CD admin privileges
- DevOps Change: sn_devops.admin or sn_devops.tool_owner
Argo CD doesn't provide an option to directly test for webhook connectivity. To configure webhooks, see Configure webhooks in Argo CD manually.