This page describes Secure Source Manager webhooks. To set up a webhook, follow the instructions in Set up webhooks.
Webhooks are HTTP requests triggered by an event in a Secure Source Manager repository, and then sent to a user-specified URL.
Webhook settings
Webhooks can only be configured in the Secure Source Manager web interface. The following fields are configurable:
- Hook ID
- Human-readable name for the webhook. Hook IDs must follow the resource naming convention. They must include only lower case letters, numbers, or dashes, must begin with a letter, and cannot be changed after creating the webhook.
- Target URL
- Webhook target URL. A webhook target is an open and public URL.
- Sensitive query string
Sensitive query strings are attached to the end of the target URL in the format
TARGET_URL?SENSITIVE_QUERY_STRING.Most services provide a token or a secret to ensure that the incoming requests are from an authorized service. In order to verify the request you can store the required token or secret in the sensitive query string.
- Trigger on
Event to trigger the webhook request. Options are Push to trigger on a push to the repository, or Pull request state changed to trigger on pull request opened, closed, reopened, or edited.
- Git refs filter for push events
A filter to specify which branches to report on for push events specified as a glob pattern. See the glob documentation for syntax.
- Active
The webhook sends requests on trigger events when selected. If unselected, no requests are sent.
Test webhooks
After you configure your webhook, you can test the webhook by using the Test Delivery button in the webhooks tab.
What's next
- Use webhooks to connect to Jenkins.
- Set up webhooks.