> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/scan-and-analyze-with-ox/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/webhooks-pipeline-integration.md).

# Webhooks Pipeline Integration

You can configure source control systems to notify OX using a webhook on relevant events. Webhooks can be set up once for each group or project.

This method is useful for customers managing many repositories or using UI-driven CI/CD.

Webhook settings control how OX interacts with your source control system to report scan statuses and trigger scans automatically.

These settings define whether OX sends status updates, such as scan started/finished, back to the platform, and which branch events trigger scans.

**To set webhooks:**

1. Go to the **Applications** page and select the applications in which you want to apply pipeline scan.
2. Click the **Pipeline Settings icon** at the top.
3. In the **Webhooks** section of the **Pipelines** dialog, perform webhook configuration by source control platform, as follows:

   * For GitLab Webhooks integration, enable **GitLab Commit Status and Merge Request Notes Reporting**.

   <figure><img src="/files/vraj88v6n30OrHQjAnD2" alt=""><figcaption></figcaption></figure>

   * For GitHub App integration, enable **GitHub Checks**.

   <figure><img src="/files/PHtUdTImSIpDDdxdr9lu" alt="" width="563"><figcaption></figcaption></figure>

   * For Bitbucket App integration, enable **Bitbucket Code Insights and Build Status Reporting**.

   <figure><img src="/files/IJfWqpKoMj2iCIe11k8h" alt=""><figcaption></figcaption></figure>
4. Define which branches and events to monitor. You can use default options (e.g., `main`, `protected`) or patterns like `release-*`.

| Setting                        | Description                                                                                                                                 | Recommendation                                                                      |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| Branch Event Types to Scan     | Specifies the types of branch events (Push, Pull Request) that trigger scans.                                                               | Choose Pull Request for protected/default branches. Customize for others as needed. |
| Branch Filters (Name Patterns) | Define naming patterns for branches to include in scan events. You can use wildcard (`*`) to include multiple branches with similar naming. | Use this to scan custom branch types, e.g., `release-*` or `feature-*`.             |

6. Select **SAVE**.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ox.security/scan-and-analyze-with-ox/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/webhooks-pipeline-integration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.