JP Joom2Static - Webhooks and REST API
Article Index
- JP Joom2Static
- Why use JP Joom2Static?
- What's New in JP Joom2Static
- Installation
- General Configuration
- Menu and Asset Configuration
- Image Optimization
- .htaccess Settings
- Manual Files and Protected Sites
- Webhooks and REST API
- Deployment
- FTP Deployment
- Netlify Deployment
- AWS S3 Deployment
- GitHub Pages Deployment
- Generate Static HTML
- Configuration Parameter Reference
- Security Recommendations
- Conclusion
- All Pages
Webhooks & REST API Triggers
JP Joom2Static provides automation endpoints that allow external systems to integrate with the static generation process.
Webhook Secret Token
Parameter: webhook_secret
The Webhook Secret Token protects the standalone static generation endpoint.
If a token has not already been configured, JP Joom2Static can generate a secure token automatically.
Keep this token private. Anyone with access to the complete webhook URL may be able to initiate the configured export process.
Webhook Trigger URL
JP Joom2Static automatically displays the webhook trigger URL.
The URL follows this structure:
https://your-domain.com/administrator/components/com_jp_joom2static/webhook.php?secret=YOUR_SECRET
This endpoint allows authorized external applications to trigger static-site generation without requiring an interactive Joomla administrator login.
REST API Status Endpoint
JP Joom2Static also provides a status endpoint using the following structure:
https://your-domain.com/index.php?option=com_jp_joom2static&task=api.status
This endpoint can be used by integrations to access the available JP Joom2Static API/status information.
