Comment on page
Hooks
Hooks allow you to build or set up integrations that subscribe to certain events on DoltHub, such as pushing data. You give DoltHub the URL of an HTTP endpoint you've set up to accept POST requests, and then when certain events happen your endpoint will receive a payload.
Some common workflows involving hooks include:
- Updating an external issue tracker
- Creating automatic releases
DoltHub hooks currently only support push, pull request and branch events on a database, while GitHub supports a much longer list of events on both organizations and repositories.
This blog covers an in depth example for how to set up a webhook for a push event on DoltHub. You can add and manage webhooks in the settings tab of any of your DoltHub databases.
This event occurs when a commit is pushed.
The payload delivered for a push event webhook contains information about the push that was made to the database. The payload is a JSON object that includes the following fields:
Key | Type | Description |
|---|---|---|
event_name | string | The name of the event triggered by the webhook. In this case, it will always be "push". |
ref | string | The name of the branch that was pushed. |
head | string | The SHA of the most recent commit on ref after the push. |
prev | string | The SHA of the most recent commit on ref before the push. |
repository.name | string | The name of the database where the push occurred. |
repository.owner | string | The owner (username or org name) of the database where the push occurred. |
An example of the payload:
{
"event_name": "push",
"ref": "refs/heads/main",
"head": "ns725d8noah3m0mjjvrilet1rsmcgna2",
"prev": "6higvr7ic9ndahfruh3kufu409im44jd",
"repository": {
"name": "test",
"owner": "liuliu"
}
}
The pull request event webhook is triggered whenever a pull request is created, merged, or closed. The payload includes these fields:
Key | Type | Description |
|---|---|---|
event_name | string | The name of the event triggered by the webhook. In this case, it will always be "pull_request". |
repository.name | string | The name of the database for the pull request base. |
repository.owner | string | The owner (username or org name) of the pull request base. |
pullID | string | The ID of the pull request that triggered the webhook. |
action | string | The action that triggered the webhook (Opened, Closed, Merged.). |
state | string | The current state of the pull request after the event. |
fromRepository.name | string | The name of the database where the pull request is created from. |
fromRepository.name | string | The owner of the database where the pull request is created from. |
fromBranch | string | The branch that the pull request is created from. |
toBranch | string | The branch that the pull request wants to merge into. |
author | string | The author of the pull request. |
sender | string | The user who triggered the event. |
An example of the payload object:
{
"event_name": "pull_request",
"repository": {
"name": "test",
"owner": "dolthub"
},
"pullID": "15",
"action": "Opened",
"state":"Open",
"fromBranch": "liuliu/feature-branch",
"toBranch": "main",
"author": "liuliu",
"fromRepository": {
"name": "test",
"owner": "liuliu"
},
"sender": "liuliu"
}
A branch Event Webhook is triggered when a branch is created or deleted. The payload includes these fields:
Key | Type | Description |
|---|---|---|
event_name | string | The name of the event. In this case, it will always be "branch". |
repository.name | string | The name of the database where the branch is located. |
repository.owner | string | The owner (username or org name) of the database where the branch change occurred. |
branch | string | The full name of the branch (e.g., refs/heads/main). |
action | string | The action that triggered the webhook (deleted or created the branch). |
An example of the payload:
{
"event_name": "branch",
"repository": {
"name": "test",
"owner": "liuliu"
},
"branch": "liuliu/workspace-fashionable-sponge",
"action": "Deleted branch"
}
Last modified 5mo ago