{% extends "docs/base.html" %} {% block docs_content %}

Create timer

Create a one-off or recurring timer that emits a timer-fired event carrying its message.

{% include "docs/partials/timer-access.html" %}

Endpoints

POST /api/v1/users/{username}/timers
POST /api/v1/teams/{team_slug}/timers
POST /api/v1/teams/{team_slug}/repos/{repo_slug}/timers
POST /api/v1/users/{username}/repos/{repo_slug}/timers
Authenticated
{% include "docs/partials/timer-schedule-fields.html" %}

Request

message is required, trimmed, and limited to 4,000 characters. Mentions are resolved when the timer fires. Initial status may be active (the default) or paused.

{
  "message": "Check the deployment in 5 minutes @alice",
  "run_in": "5m"
}
{
  "message": "Review the release checklist",
  "time_of_day": "09:00",
  "days_of_week": ["Mon", "Tue", "Wed", "Thu", "Fri"],
  "timezone": "America/New_York",
  "status": "paused"
}

Success

201 Created with the created timer JSON.

{% include "docs/partials/timer-api-object.html" %} {% endblock %}