Add webhook and event-triggered automation documentation#156
Draft
Add webhook and event-triggered automation documentation#156
Conversation
- Add webhook endpoints to API reference table - Document event trigger types with full GitHub event keys - Add JMESPath filter expressions with functions (glob, icontains, contains, regex, etc.) - Include practical examples for common use cases: - Respond to @OpenHands mentions in comments - Auto-review PRs with 'openhands' label - Run tests on push to main - Triage new issues in org repos - Document custom webhook registration and management - Update README with quick start examples for event triggers - Update skill triggers to include webhook-related keywords Co-authored-by: openhands <openhands@all-hands.dev>
- Replace Stripe with Linear as the primary custom webhook example - Show how to pass your own webhook_secret from Linear - Document Linear-specific fields (Linear-Signature header, type event key) - Add examples for Issue create and high-priority update automations - Add reference table for common service signature headers Co-authored-by: openhands <openhands@all-hands.dev>
- Instruct agent to provide curl request, not execute it - Ask user about webhook secret before creating request Co-authored-by: openhands <openhands@all-hands.dev>
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
2 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.
Why
The automation skill documentation only covered cron-triggered automations. Users need documentation for:
Summary
@openhandsmentions in commentsopenhandslabelIssue Number
N/A
How to Test
Review the updated documentation files:
skills/automation/SKILL.md- Full API reference with webhook/event sectionsskills/automation/README.md- Updated quick start with event trigger examplesKey examples to verify:
contains(pull_request.labels[].name, 'openhands')icontains(comment.body, '@openhands')Video/Screenshots
N/A - Documentation changes only
Notes
This PR was created by an AI assistant (OpenHands) to document the event-triggered automation capabilities that were already implemented in the automation service.
@malhotra5 can click here to continue refining the PR