trunk.io Webhook Event Types
This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
action
The type of action that triggered the webhook
author
The username of the author of the PR
http_details_url
Web link to the details about this PR
pr_number
repository
3 Items
status
The current status of the PR
target_branch
The name of the branch targeted by the merge queue where the event occurred
{
"action": "canceled",
"author": "mmatheson",
"http_details_url": "https://app.trunk.io/gh/trunk-io/mergequeue/merge/main/8762",
"pr_number": 1234,
"repository": {
"host": "github.com",
"name": "mergequeue",
"owner": "trunk-io"
},
"status": "canceled",
"target_branch": "main"
}action
The type of action that triggered the webhook
author
The username of the author of the PR
failure_reason
http_details_url
Web link to the details about this PR
pr_number
repository
3 Items
status
The current status of the PR
target_branch
The name of the branch targeted by the merge queue where the event occurred
{
"action": "failed",
"author": "mmatheson",
"failure_reason": "TEST_RUN_REQUIRED_STATUS_FAILED",
"http_details_url": "https://app.trunk.io/gh/trunk-io/mergequeue/merge/main/8762",
"pr_number": 1234,
"repository": {
"host": "github.com",
"name": "mergequeue",
"owner": "trunk-io"
},
"status": "failed",
"target_branch": "main"
}action
The type of action that triggered the webhook
author
The username of the author of the PR
http_details_url
Web link to the details about this PR
pr_number
repository
3 Items
status
The current status of the PR
target_branch
The name of the branch targeted by the merge queue where the event occurred
{
"action": "merged",
"author": "mmatheson",
"http_details_url": "https://app.trunk.io/gh/trunk-io/mergequeue/merge/main/8762",
"pr_number": 1234,
"repository": {
"host": "github.com",
"name": "mergequeue",
"owner": "trunk-io"
},
"status": "merged",
"target_branch": "main"
}action
The type of action that triggered the webhook
author
The username of the author of the PR
http_details_url
Web link to the details about this PR
pr_number
repository
3 Items
status
The current status of the PR
target_branch
The name of the branch targeted by the merge queue where the event occurred
{
"action": "queued",
"author": "mmatheson",
"http_details_url": "https://app.trunk.io/gh/trunk-io/mergequeue/merge/main/8762",
"pr_number": 1234,
"repository": {
"host": "github.com",
"name": "mergequeue",
"owner": "trunk-io"
},
"status": "queued",
"target_branch": "main"
}action
The type of action that triggered the webhook
author
The username of the author of the PR
http_details_url
Web link to the details about this PR
pr_number
repository
3 Items
status
The current status of the PR
target_branch
The name of the branch targeted by the merge queue where the event occurred
{
"action": "submitted",
"author": "mmatheson",
"http_details_url": "https://app.trunk.io/gh/trunk-io/mergequeue/merge/main/8762",
"pr_number": 1234,
"repository": {
"host": "github.com",
"name": "mergequeue",
"owner": "trunk-io"
},
"status": "submitted",
"target_branch": "main"
}action
The type of action that triggered the webhook
author
The username of the author of the PR
http_details_url
Web link to the details about this PR
pr_number
repository
3 Items
status
The current status of the PR
target_branch
The name of the branch targeted by the merge queue where the event occurred
{
"action": "testing",
"author": "mmatheson",
"http_details_url": "https://app.trunk.io/gh/trunk-io/mergequeue/merge/main/8762",
"pr_number": 1234,
"repository": {
"host": "github.com",
"name": "mergequeue",
"owner": "trunk-io"
},
"status": "testing",
"target_branch": "main"
}action
The type of action that triggered the webhook
pr_numbers
repository
The repository the merge queue is merging into
3 Items
status
The current statusof the Pull Request batch
target_branch
The name of the branch targeted by the merge queue where the event occurred
test_branch
The branch the pull request batch was tested on
test_branch_sha
The SHA of the branch the pull request batch was tested on
test_pr_number
The number of the pull request used to test the pull request batch
{
"action": "merged",
"pr_numbers": [
1,
2
],
"repository": {
"host": "github.com",
"name": "trunk-io",
"owner": "mergequeue"
},
"status": "some string",
"target_branch": "main",
"test_branch": "trunk-merge/pr-1-2/abc123",
"test_branch_sha": "a23f8853080d3fe873c3419a735513898c2329f500ce6aa39cf2253213fd00e4",
"test_pr_number": 15
}quarantine_setting_changed
The quarantining setting that was changed
5 Items
test_case
15 Items
type
The type of webhook event that occurred
{
"quarantine_setting_changed": {
"actor": {
"email": "string",
"full_name": "string"
},
"previous_quarantining_setting": "UNSPECIFIED",
"reason": "string",
"timestamp": "2019-08-24T14:15:22Z",
"updated_quarantining_setting": "ALWAYS_QUARANTINE"
},
"test_case": {
"classname": "string",
"codeowners": [
"string"
],
"failure_rate_last_7d": 0,
"file_path": "string",
"html_url": "http://example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parent": "string",
"pull_requests_impacted_last_7d": 0,
"quarantined": true,
"repository": {
"html_url": "http://example.com"
},
"status": {
"reason": "string",
"timestamp": "2019-08-24T14:15:22Z",
"value": "healthy"
},
"test_suite": "string",
"ticket": {
"html_url": "http://example.com"
},
"variant": "string"
},
"type": "test_case.quarantining_setting_changed"
}status_change
2 Items
test_case
15 Items
type
The type of webhook event that occurred
{
"status_change": {
"current_status": {
"reason": "string",
"timestamp": "2019-08-24T14:15:22Z",
"value": "healthy"
},
"previous_status": "healthy"
},
"test_case": {
"codeowners": [
"string"
],
"failure_rate_last_7d": 0,
"file_path": "string",
"html_url": "http://example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"pull_requests_impacted_last_7d": 0,
"quarantined": true,
"repository": {
"html_url": "http://example.com"
},
"status": {
"reason": "string",
"timestamp": "2019-08-24T14:15:22Z",
"value": "healthy"
},
"test_suite": "string",
"ticket": {
"html_url": "http://example.com"
},
"variant": "string"
},
"type": "test_case.status_changed"
}