canvas webhook
canvas webhook¶
Manage Canvas webhook listeners
Synopsis¶
Start and manage webhook listeners for Canvas LMS events.
The webhook listener receives real-time notifications from Canvas for various events like assignment creation, submission updates, grade changes, enrollment changes, and more.
The listener provides: - JWT verification for Canvas Data Services (recommended) - HMAC signature verification for custom integrations - Event routing to specific handlers - Graceful shutdown - Health check endpoint - Request logging
Examples:
# Start with Canvas Data Services JWT verification (recommended)
canvas webhook listen --canvas-data-services
# Start with HMAC signature verification
canvas webhook listen --secret your-secret-key
# Start with custom JWK URL
canvas webhook listen --jwks-url https://your-jwks-endpoint.com/jwks
# Listen for specific event types
canvas webhook listen --events submission_created,grade_change
# List available event types
canvas webhook events
Options¶
Options inherited from parent commands¶
--as-user int Masquerade as another user (admin feature, requires permission)
--columns strings Select specific columns to display (comma-separated)
--config string config file (default is $HOME/.canvas-cli/config.yaml)
--dry-run Print curl commands instead of executing requests
--filter string Filter results by text (case-insensitive substring match)
--instance string Canvas instance URL (overrides config)
--limit int Limit number of results for list operations (0 = unlimited)
--no-cache Disable caching of API responses
-o, --output string Output format: table, json, yaml, csv (default "table")
--show-token Show actual token in dry-run output (default: redacted)
--sort string Sort results by field (prefix with - for descending, e.g., -name)
-v, --verbose Enable verbose output
SEE ALSO¶
- canvas - Canvas LMS CLI - Interact with Canvas from the command line
- canvas webhook events - List available Canvas webhook event types
- canvas webhook listen - Start webhook listener server