Test webhooks manually

Release version: Washingtondc

Updated August 1, 2024

4 minutes to read

Summarize

Summarized using AI

Summary of Test Webhooks Manually

This guide provides steps for ServiceNow customers to manually test webhooks for various tools, including GitLab, Rally, Split.io, Jira, Bitbucket, and Argo CD. It is essential for troubleshooting connection issues between these tools and ServiceNow's DevOps Change Velocity.

Show full answer Show less

Key Features

GitLab: Requires GitLab admin privileges. Navigate to Settings > Webhooks. Test webhooks for code and orchestration events. Reconfigure webhooks if necessary.
Rally: Requires Rally admin privileges. No direct testing option; check for active webhooks under My Settings > System Administration > Extensions > Webhooks.
Split.io: Requires Split.io admin privileges. No direct testing option; ensure the ServiceNow application is configured correctly under Admin Settings > Integration settings.
Jira: Requires Jira admin privileges. Check webhooks under Administration > System > WebHooks (Jira Server) or Settings > System > WebHooks (Jira Cloud) for active status and correct Tool ID and secret token.
Bitbucket: Requires Bitbucket admin privileges. Check webhooks under Repository settings > Workflow > Webhooks for active status and correct Tool ID and secret token.
Argo CD: Requires Argo CD admin privileges. Manual configuration of webhooks is necessary.

Key Outcomes

By following the above steps, ServiceNow customers can ensure their webhooks are correctly configured and functioning, enabling seamless integration and communication between ServiceNow and other development tools. This process helps to quickly identify and resolve any connectivity issues, ensuring continuous workflow efficiency.

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

Role required:

GitLab: GitLab admin privileges
DevOps Change: sn_devops.admin or sn_devops.tool_owner

To test webhooks manually in GitLab, you must:

Navigate to GitLab and select the project for which you want to test webhooks.
Navigate to Settings > Webhooks.
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.

For detailed information about webhooks in GitLab, see Webhooks.

Rally

Role required:

Rally: Rally admin privileges
DevOps Change: sn_devops.admin or sn_devops.tool_owner

Rally doesn't provide an option to directly test for webhook connectivity. If you're not seeing Rally events in DevOps Change Velocity, you can try the following options:

From your Rally instance, navigate to My Settings > System Administration > Extensions > Webhooks.

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

Role required:

Split.io: Split.io admin privileges
DevOps Change: sn_devops.admin or sn_devops.tool_owner

Split.io doesn't provide an option to directly test for webhook connectivity. If you're not seeing Split.io events in DevOps Change Velocity, you can try the following options:

From your Split.io instance, navigate to Admin Settings > Integration settings > Integrations. 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

Role required:

Jira: Jira admin privileges
DevOps Change: sn_devops.admin or sn_devops.tool_owner

Jira doesn't provide an option to directly test for webhook connectivity. If you're not seeing Jira events in DevOps Change Velocity, you can try the following options:

Navigate to:
- For Jira Server navigate to Administration > System > WebHooks.
- For Jira Cloud instance, navigate to Settings > System > WebHooks.
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

Role required:

Bitbucket: Bitbucket admin privileges
DevOps Change: sn_devops.admin or sn_devops.tool_owner

Bitbucket doesn't provide an option to directly test for webhook connectivity. If you're not seeing Bitbucket events in DevOps Change Velocity, you can try the following options:

Navigate to Bitbucket and select the repository for which you want to test webhooks. Navigate to Repository settings > Workflow > Webhooks.

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

Role required:

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.