Test webhooks manually
Summarize
Summary of Test Webhooks Manually
This guide explains how ServiceNow customers can manually test and troubleshoot webhook connections for various DevOps tools integrated with DevOps Change Velocity, including GitLab, Rally, Split.io, Jira, Bitbucket, and Argo CD. Since some tools do not provide direct webhook testing capabilities, the document offers practical steps to verify and reconfigure webhooks to ensure event data flows correctly into DevOps Change Velocity.
Show less
Testing and Troubleshooting Webhooks by Tool
- GitLab:
- Requires GitLab admin and DevOps Change admin/tool owner roles.
- Test webhooks directly via GitLab’s Project Settings > Webhooks by selecting “Test” and choosing event types like Push events.
- Receive success or error messages to confirm connection status.
- If errors occur, reconfigure webhooks via DevOps Change Velocity or verify URL toolId and secret token values against tool records.
- Rally:
- Requires Rally admin and DevOps Change admin/tool owner roles.
- No direct webhook test option; verify webhook exists and is active in Rally’s Extensions > Webhooks.
- Reconfigure the webhook from the DevOps Change Velocity project record if events are missing.
- Split.io:
- Requires Split.io admin and DevOps Change admin/tool owner roles.
- No direct webhook test; verify ServiceNow DevOps integration status and configuration in Split.io Admin Settings.
- Reconfigure the webhook in DevOps Change Velocity if needed.
- Jira:
- Requires Jira admin and DevOps Change admin/tool owner roles.
- No direct test; check webhook existence and enabled status in Jira System settings.
- Validate Tool ID and secret token in webhook URL against DevOps Change Velocity tool records.
- Reconfigure webhooks via DevOps Change Velocity as necessary.
- Note differences in webhook creation between OAuth 2.0 and basic authentication methods.
- Bitbucket:
- Requires Bitbucket admin and DevOps Change admin/tool owner roles.
- No direct test; verify webhook presence and active status under repository settings.
- Confirm Tool ID and secret token match DevOps Change Velocity tool records.
- Reconfigure webhooks from DevOps Change Velocity tool record.
- Argo CD:
- Requires Argo CD admin and DevOps Change admin/tool owner roles.
- No direct test available; configure webhooks manually as per Argo CD guidelines.
Practical Actions for ServiceNow Customers
- Verify admin privileges both in the third-party tool and in DevOps Change Velocity before attempting webhook tests or reconfiguration.
- Use the DevOps Change Velocity interface to reconfigure webhooks for projects or tools when connectivity issues arise.
- Confirm webhook URLs contain correct toolId and secret token values by cross-referencing with DevOps Change Velocity tool records.
- For tools without direct webhook test options, check webhook status and configuration within the respective tool’s settings.
- Be mindful of authentication methods (e.g., OAuth 2.0 vs basic auth in Jira) as they affect webhook creation and management.
Following these steps helps ensure reliable webhook connections, enabling seamless event integration between your DevOps tools and ServiceNow DevOps Change Velocity for effective change velocity management.
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.