Trigger Test by Git Commit

You can automatically trigger Apidog automated tests through Git commit events (such as push, pull request) without any manual intervention. This feature works across any CI/CD platform, including GitHub Actions, Jenkins, GitLab CI, and more.

Core Principle: Event Trigger + CLI Command Execution

Automatically triggering Apidog tests after a Git commit is based on a universal principle:

Whether it’s through a Webhook or the built-in event listener provided by the CI/CD platform (e.g., on: push in GitHub Actions), the essence is the same:
monitoring Git commit events and executing Apidog’s test command.

As long as your CI/CD environment can respond to Git commits and execute a command-line script, you can integrate Apidog automated testing.

There are generally two trigger mechanisms:

1. Built-in event mechanisms (e.g., GitHub Actions, GitLab CI)

GitHub Actions, for example, provides an event configuration like:

This method requires no Webhook configuration. The platform monitors events internally and is a lightweight approach.

2. External Webhooks (e.g., Jenkins, self-hosted services)

When using Jenkins or cross-platform setups, you typically need to configure Webhooks manually.

Common CI/CD Integration Examples

Triggering automated tests through built-in event mechanisms:

Integrate with Github Actions

Integrate with Gitlab

Cross-Platform Integration Example: GitHub Actions + Jenkins

Scenario

Code repository is hosted on GitHub

Pipeline execution environment is Jenkins

Use GitHub Webhook to trigger Jenkins pipeline

Execute apidog run in Jenkins to run Apidog automated tests

Step 1: Configure Jenkins Project

Refer to Integrate with Jenkins to create a project and successfully configure it.

Step 2: Get the Webhook URL

Webhook URL is the entry point Jenkins uses to receive external requests and trigger pipelines. You can obtain this URL in multiple ways, such as using the Generic Webhook Trigger plugin.

In Jenkins Plugin Manager, search for and install the "Generic Webhook Trigger" plugin. Restart Jenkins after installation.

In Jenkins Dashboard, select your project and go to Configure. Enable Generic Webhook Trigger.
Webhook URL is: http://<your Jenkins host>/generic-webhook-trigger/invoke