Skip to main content
The tickward API is available under:
https://tickward.com/api/v1
Use Bearer API keys created in settings. Read-only keys can list and retrieve resources. Full-access keys can create, update, and delete resources. For write retries, send Idempotency-Key on POST, PATCH, and DELETE requests. The same key with the same method, path, query, and JSON body replays the original response for up to 24 hours. tickward stores only a hash of the key. Use GET /capabilities before automation chooses a workflow. It returns the available features and limits without requiring an API key. For destructive project or space deletes, call the same DELETE endpoint with dry_run=true first. Dry runs return a preview with resource names, labels, counts, and the apply path. They do not mutate data. For multi-resource project setup, call POST /projects/preview with the same payload you plan to create. Then call POST /projects with the returned plan_hash as expected_plan_hash. Webhook delivery is asynchronous. Create and manage webhook endpoints in Settings or through /webhooks, then run the scheduler tick endpoint from Cloudflare Cron, EventBridge, a VPS cron job, or another scheduler. See Webhooks and scheduler. Remote MCP clients use OAuth through the configured MCP endpoint. Local scripts, CLI tools, and self-hosted agents can use API keys created in settings. OAuth connections are enforced by scope. Read-only can inspect resources, Scoped write can write only for selected resource scopes, and Full access can read and write all supported resources. Calls outside the granted scope return insufficient_scope with the missing required_scope.

Resources

  • Capabilities describe supported API workflows and limits.
  • Projects group timers and spaces.
  • Timers track countdown dates, timezones, recurrence, alerts, and sharing. Use effective_target_date for the current countdown date; recurring timers keep target_date as their original schedule anchor. Timer responses include project_name so agents can avoid raw project ids in confirmations.
  • Spaces organize timers inside a project. Space responses include project_name.
  • Shares create static public links for individual timers. Share responses include project_name and timer_label when the timer still exists.
  • Webhooks send account events to HTTPS endpoints. Use PATCH /webhooks/{id} to edit event subscriptions or pause an endpoint, and DELETE /webhooks/{id} only when the endpoint and delivery history should be removed.

For agents

Start with GET /projects, resolve the project the user means, and ask for confirmation before deleting anything.