Webhooks
Webhooks are available on the Enterprise plan.
What is a Webhook?
A webhook in Git is a mechanism that allows a Git repository to notify external systems about events that occur within the repository. Think of it as an automated messenger that sends real-time updates when specific actions happen in your repository.
A Git webhook is:
- Event-driven notification: A way for Git repositories to send HTTP POST requests to a specified URL when certain events occur
- Automation trigger: A method to automatically initiate actions in external systems based on Git activities
- Integration mechanism: A bridge between your Git repository and other tools or services
Common Use Cases
Git webhooks enable numerous automation scenarios:
- Continuous Integration/Deployment: Triggering builds and deployments when code changes
- Issue tracking integration: Updating tickets when commits reference issues
- Chat notifications: Sending events to a service of yours that posts alerts to Slack/Teams/Discord
- Documentation updates: Automatically regenerating documentation after changes
- Custom automations: Initiating specific workflows unique to your development process
- Monitoring and analytics: Tracking repository activity in external systems
Creating and Managing Webhooks
APIGit supports configuring multiple webhooks to report repository events to external systems. To configure webhooks:
- Navigate to your API repository
- Select the Settings tab
- Go to Webhooks
- View existing webhooks under Webhook Endpoints or create new ones

Use the actions of a webhook to edit or delete it.
Adding a New Webhook
To create a new webhook, click the Add WebHook button in the upper left corner. You’ll need to provide:
- Remote Url: The endpoint that will receive the webhook events
- Content type:
application/jsonorapplication/x-www-form-urlencoded - Branch Filter: A glob pattern that limits push, branch creation and branch deletion events to matching branches, such as
mainor{main,release*}. Leave it as*for all branches - Authorization Header: Sent with each request when present, for example
Bearer token123456. There is no separate signing secret, so use this header to authenticate requests - Active: Untick it to pause the webhook
- When should this webhook be triggered?: Which events should trigger the webhook

Customizing Event Triggers
APIGit provides granular control over which events will trigger your webhook. Choose Just the push event, I need everything, or custom events to select specific events based on your integration needs.

| Group | Event | Fires when |
|---|---|---|
| Repository Events | Create | Branch or tag created |
| Repository Events | Delete | Branch or tag deleted |
| Repository Events | Fork | Repository forked |
| Repository Events | Push | Git push to a repository |
| Repository Events | Repository | Repository created or deleted |
| Issue Events | Issues | Issue opened, closed, reopened, or edited |
| Issue Events | Issue Assigned | Issue assigned or unassigned |
| Issue Events | Issue Labeled | Issue labels updated or cleared |
| Issue Events | Issue Milestoned | Issue milestoned or demilestoned |
| Issue Events | Issue Comment | Issue comment created, edited, or deleted |
| Pull Request Events | Pull Request | Pull request opened, closed, reopened, or edited |
| Pull Request Events | Pull Request Assigned | Pull request assigned or unassigned |
| Pull Request Events | Pull Request Labeled | Pull request labels updated or cleared |
| Pull Request Events | Pull Request Milestoned | Pull request milestoned or demilestoned |
| Pull Request Events | Pull Request Comment | Pull request comment created, edited, or deleted |
| Pull Request Events | Pull Request Reviewed | Pull request approved, rejected, or review comment |
| Pull Request Events | Pull Request Synchronized | Pull request synchronized |
| Pull Request Events | Pull Request Review Requested | Pull request review requested or review request removed |
Once configured, your webhooks will automatically notify your external systems whenever the selected events occur in your repository, enabling seamless integration with your broader development ecosystem.