Submit Heartbeat Event

Submit a heartbeat check-in to signal that a scheduled job or background task has run successfully. To record a new event, provide the heartbeat_id in the path. You can also include an optional result (e.g., success, fail) and a custom message in the request body to describe the event outcome.

Each check-in helps verify that your monitored service is operational and reporting on schedule. If check-ins are not received within the configured interval, the system will automatically mark the heartbeat as failed.

Use cases:

• Automated job reporting — Ping this endpoint from cron jobs, queue workers, or scripts to indicate successful execution.
• Failure tracking — Send a fail result to indicate that a job ran but encountered an issue.
• Operational logging — Include meaningful messages with each event to support debugging and job history reviews.