Test webhooks manually
Summarize
Summary of Test webhooks manually
This guide explains how to manually test and troubleshoot webhook connections for various DevOps tools integrated with ServiceNow DevOps Change Velocity, including GitLab, Rally, Split.io, Jira, Bitbucket, and Argo CD. Since some tools do not offer direct webhook testing capabilities, the document outlines specific 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: You can manually test webhooks by navigating to the project’s Settings > Webhooks and using the Test function with push or tag push events. Success or error messages indicate webhook status. If errors occur, reconfigure webhooks via DevOps Change Velocity or verify the toolId and Secret token in the webhook URL against the tool record.
- Rally: Direct webhook testing is not available. Confirm that the DevOps Change webhook exists and is active under My Settings > System Administration > Extensions > Webhooks in Rally. Reconfigure via DevOps Change Velocity if events are missing.
- Split.io: No direct test option. Check the integration status under Admin Settings > Integration settings > Integrations in Split.io and ensure the ServiceNow DevOps app is active and properly configured. Reconfigure through DevOps Change Velocity if needed.
- Jira: Direct testing is unavailable. Verify webhooks under Administration > System > WebHooks (Server) or Settings > System > WebHooks (Cloud). Ensure webhook status is enabled, and toolId and secret token in the URL match DevOps Change Velocity records. Reconfigure webhooks from DevOps Change Velocity as required.
- Bitbucket: Cannot test directly. Validate webhook existence and status under Repository settings > Workflow > Webhooks. Confirm the webhook is active and that the toolId and secret token in the URL correspond to values in DevOps Change Velocity. Reconfigure if necessary.
- Argo CD: No direct webhook testing available. Webhooks must be configured manually following specific configuration instructions.
Key Actions for Customers
- Use the provided navigation paths and role requirements to access webhook settings in each tool.
- When testing is possible (GitLab), use the test functions to verify webhook configurations.
- If events are not received, validate webhook status, tool IDs, and secret tokens against records in DevOps Change Velocity.
- Reconfigure webhooks from DevOps Change Velocity using the Configure option to reset webhook settings for the project or tool.
- Understand differences in webhook creation for Jira based on authentication method (OAuth 2.0 vs. basic authentication) to avoid duplicates.
Following these steps helps maintain reliable webhook connectivity between your DevOps tools and ServiceNow DevOps Change Velocity, ensuring accurate and timely event data integration.
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.