Add documentation for webhook triggers - #3307
Draft
mik-ky wants to merge 4 commits into
Draft
Conversation
mik-ky
force-pushed
the
ck/webhook-triggers-doc
branch
from
August 5, 2026 22:09
29e064c to
9c407f3
Compare
|
Pull request environment is available at https://stoctodocspr3307.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
benPearce1
reviewed
Aug 5, 2026
| - Restart a service when your incident management tool creates an incident. | ||
|
|
||
| :::div{.warning} | ||
| Webhook runbook triggers are available from Octopus version **2026.3**. This feature can be disabled for your instance under **Configuration ➜ Features**. |
Contributor
There was a problem hiding this comment.
before we merge this we should change the default state of the feature toggle
mik-ky
changed the title
benPearce1
approved these changes
Aug 7, 2026
Comment on lines
+72
to
+77
| ```bash | ||
| curl -X POST https://your-octopus-url/api/Spaces-1/webhook/00000000-0000-0000-0000-000000000000 \ | ||
| -H "X-Octopus-ApiKey: API-YOUR-KEY" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ "reason": "Disk usage above threshold" }' | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for webhook triggers
SI-287