Triggering a Task — TimeHive Docs

Triggering a Task (API Reference)

To log time saved, your automation must send an HTTP POST request to the Time Hive ingestion API upon successful completion.

Endpoint

POST https://api.timehive.io/ingest

Headers

Authorization: Bearer <YOUR_INGEST_TOKEN>
Content-Type: application/json

Payload

At a minimum, you must specify which task to log the event against, unless you configured a Default Task for your Integration. If no Default Task is set, you must pass task_id in your payload. One integration can log to any task in its project this way.

Use the full Task ID. Open the task and click Copy task ID (or copy it from the integration page). It is a UUID such as 271a869c-316f-4568-9f1c-96fa01b297d8. The short tsk_271a86 label shown in the app is only a display tag and will be rejected.

{
  "task_id": "271a869c-316f-4568-9f1c-96fa01b297d8",
  "event_type": "run",
  "status": "processed",
  "count": 1
}

Batching Events

If your automation processed 50 records at once, you can pass the count parameter to log them all simultaneously without making 50 API calls:

{
  "task_id": "271a869c-316f-4568-9f1c-96fa01b297d8",
  "event_type": "run",
  "status": "processed",
  "count": 50
}

Note: If the automation fails, you can send "status": "failed". Failed events are logged for your audit trail but do not contribute to your time-saved metrics.

For more detailed information on all available payload parameters, read the API Reference.