BKM4 Jira Team Work Log Tracking API
Service is running.
Health check: /api/health
Full guide: /api/help
Total Endpoints
6
GET
4
POST
2
Secured
3
API Catalog
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /api |
Public | Landing page with service overview and endpoint index. |
| GET | /api/health |
Public | Health probe returning service metadata and server time. |
| POST | /api/reports/run |
x-cron-secret or ?token= | Trigger report generation manually from trusted callers. |
| GET | /api/reports/retry |
?token= | Retry the report flow from Chat action/open-link callback. |
| GET | /api/cron |
Authorization: Bearer or ?token= | Dedicated Vercel cron trigger endpoint for scheduled report runs. |
| POST | /api/reports/chat/events |
Google Chat callback | Receive and process inbound Google Chat app events. |
ENV Catalog
Operational environment variables used by this service.
| Variable | Required | Example | Purpose |
|---|---|---|---|
JIRA_DOMAIN |
Required | https://oneline.atlassian.net | Base URL for Jira API requests. |
JIRA_EMAIL |
Required | bot@company.com | Jira account used for API auth. |
JIRA_API_TOKEN |
Required | ATATT... (token) | Jira API token for basic authentication. |
TEAM_NAME |
Required | BKM4 | Jira project key used to build JQL and Jira check button URL. |
GOOGLE_CHAT_MODE |
Optional | webhook | app | Choose Chat delivery mode (default: webhook). |
WEBHOOK |
Required | https://chat.googleapis.com/v1/... | Google Chat incoming webhook URL (webhook mode). |
GOOGLE_CHAT_SPACE |
Optional | spaces/AAAA12345 | Target space when using Chat app mode. |
GOOGLE_CHAT_SERVICE_ACCOUNT_EMAIL |
Optional | service-account@project.iam.gserviceaccount.com | Service account identity for Chat app mode. |
GOOGLE_CHAT_SERVICE_ACCOUNT_PRIVATE_KEY |
Optional | -----BEGIN PRIVATE KEY-----... | Private key for JWT access token (Chat app mode). |
CRON_SECRET |
Optional | 7f3c9f... | Protect /reports/run and /reports/retry. |
REPORT_TIMEZONE |
Optional | Asia/Ho_Chi_Minh | Primary timezone used for report date filtering. |
TZ |
Optional | Asia/Ho_Chi_Minh | Fallback timezone if REPORT_TIMEZONE is empty. |
REPORT_DATE |
Optional | 2026-05-08 | Force report for a specific date (YYYY-MM-DD). |
APP_BASE_URL |
Optional | https://bkm4-jira-work-log-tracking.vercel.app | Used to build retry link for Chat cards. |
API_BASE_PATH |
Optional | /api | Optional API prefix for retry URL generation. |
REPORT_DEBUG |
Optional | true | Enable detailed work log aggregation logs. |
REPORT_DEBUG_AUTHORS |
Optional | Tyler,Leser | Filter debug logs for specific authors only. |