TimeTriggers
Dashboard

TimeTriggers API

v1.0.0

Schedule HTTP requests to fire at a specific time or on a recurring cron. Authentication depends on the endpoint. /schedule and /cancel accept only the ttr-api-key header; without it they answer 400. An Authorization header sent to /schedule is not used for authentication: it is stored and forwarded to the target along with your other request headers. /declare, /bulk and /tag-policies accept ttr-api-key, Authorization: Bearer <api key>, or a dashboard session cookie issued by /auth/*, checked in that order. The dashboard endpoints (/keys, /jobs, /executions) accept only the session cookie.

Fetched live from the running API’s /openapi/json endpoint on each page load, so it reflects the API version currently deployed.

triggers

delete
/canceltriggers.cancel

Headers

  • ttr-api-keystringrequired
  • ttr-trigger-idstring
  • ttr-custom-keystring

Responses

204<No Content>
400BadRequest
BadRequest
401Unauthorized
Unauthorized
404NotFound
NotFound
410Gone
Gone
getpostputpatchdelete
/scheduletriggers.schedule

Headers

  • ttr-api-keystringrequired
  • ttr-urlstringrequired
  • ttr-scheduled-atstring
  • ttr-trigger-idstring
  • ttr-custom-keystring
  • ttr-titlestring
  • ttr-tagsstring
  • ttr-run-missedstring

Responses

200ScheduleResult
ScheduleResult
400BadRequest
BadRequest
401Unauthorized
Unauthorized
402QuotaExceeded
QuotaExceeded
404NotFound
NotFound
410Gone
Gone

keys

jobs

get
/executionsjobs.listExecutions

Query parameters

  • jobIdstring
  • customKeystring
  • jobStatusstring
  • executionStatusstring
  • httpStatusstring
  • deadLetterOnlystring
  • limitstring
  • offsetstring

Responses

200ListDashboardExecutionsResponse
ListDashboardExecutionsResponse
401Unauthorized
Unauthorized
get
/jobsjobs.listJobs

Query parameters

  • statusstring
  • limitstring
  • offsetstring
  • idstring
  • titlestring
  • customKeystring
  • tagstring

Responses

200ListJobsResponse
ListJobsResponse
401Unauthorized
Unauthorized
post
/jobs/{id}/executionsjobs.replayJob

Path parameters

  • idstringrequired

Request body

  • triggeredBy?:"replay" | "retry" | null

Responses

200OkResponse
OkResponse
400BadRequest
BadRequest
401Unauthorized
Unauthorized
404NotFound
NotFound

tagPolicies

post
/tag-policiestagPolicies.createTagPolicy

Headers

  • ttr-api-keystring
  • authorizationstring

Request body

  • tag*:string
  • throughput?:object | null | null
  • maxConcurrent?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • requestTimeoutSeconds?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • retryMaxAttempts?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • retryStrategy?:"none" | "fixed" | "exponential" | null
  • retryInitialDelaySeconds?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • retryMaxDelaySeconds?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • retryJitter?:boolean | null
  • retryOn?:"network_only" | "5xx_and_network" | "non_2xx" | null

Responses

200CreateTagPolicyResponse
CreateTagPolicyResponse
400BadRequest
BadRequest
401Unauthorized
Unauthorized
put
/tag-policies/{id}tagPolicies.updateTagPolicy

Headers

  • ttr-api-keystring
  • authorizationstring

Path parameters

  • idstringrequired

Request body

  • tag?:string | null
  • throughput?:object | null | null
  • maxConcurrent?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • requestTimeoutSeconds?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • retryMaxAttempts?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • retryStrategy?:"none" | "fixed" | "exponential" | null
  • retryInitialDelaySeconds?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • retryMaxDelaySeconds?:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null     | null
  • retryJitter?:boolean | null
  • retryOn?:"network_only" | "5xx_and_network" | "non_2xx" | null

Responses

200UpdateTagPolicyResponse
UpdateTagPolicyResponse
400BadRequest
BadRequest
401Unauthorized
Unauthorized
404NotFound
NotFound
delete
/tag-policies/{id}tagPolicies.deleteTagPolicy

Headers

  • ttr-api-keystring
  • authorizationstring

Path parameters

  • idstringrequired

Responses

200OkResponse
OkResponse
401Unauthorized
Unauthorized
404NotFound
NotFound

Schemas

NotFound

  • _tag*:"NotFound"
  • message*:string

Unauthorized

  • _tag*:"Unauthorized"
  • message*:string

OkResponse

  • ok*:boolean

BadRequest

  • _tag*:"BadRequest"
  • message*:string

UpdateTagPolicyResponse

TagPolicy

  • id*:string
  • projectId*:string
  • tag*:string
  • throughput*:object | null
  • maxConcurrent*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • requestTimeoutSeconds*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • retryMaxAttempts*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • retryStrategy*:"none" | "fixed" | "exponential"
  • retryInitialDelaySeconds*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • retryMaxDelaySeconds*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • retryJitter*:boolean
  • retryOn*:"network_only" | "5xx_and_network" | "non_2xx"
  • createdAt*:string
  • updatedAt*:string

CreateTagPolicyResponse

ListTagPoliciesResponse

ListDashboardExecutionsResponse

  • executions*:DashboardExecution[]
  • total*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • limit*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • offset*:
    one of: number | "Infinity" | "-Infinity" | "NaN"

DashboardExecution

  • id*:string
  • jobId*:string
  • attemptNumber*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • triggeredBy*:"scheduler" | "retry" | "replay"
  • status*:"planned" | "started" | "complete" | "cancelled"
  • plannedAt*:string
  • startedAt*:string | null
  • completedAt*:string | null
  • responseStatus*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • responseSize*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • errorMessage*:string | null
  • rateLimitedAt*:string | null
  • rateLimitedUntil*:string | null
  • rateLimitedTags*:string[]
  • isDeadLetter*:boolean
  • lastActivityAt*:string
  • jobCustomKey*:string | null
  • jobTitle*:string | null
  • jobStatus*:"registered" | "queued" | "running" | "completed" | "cancelled" | "skipped" | "retrying"
  • jobHttpUrl*:string
  • jobHttpMethod*:string
  • projectSlug*:string

ListExecutionsResponse

Execution

  • id*:string
  • jobId*:string
  • attemptNumber*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • triggeredBy*:"scheduler" | "retry" | "replay"
  • status*:"planned" | "started" | "complete" | "cancelled"
  • plannedAt*:string
  • startedAt*:string | null
  • completedAt*:string | null
  • responseStatus*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • responseHeaders*:object | null
  • responseBody*:string | null
  • responseSize*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • errorMessage*:string | null
  • rateLimitedAt*:string | null
  • rateLimitedUntil*:string | null
  • rateLimitedTags*:string[]
  • isDeadLetter*:boolean

ListJobsResponse

  • jobs*:DashboardJob[]
  • total*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • limit*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • offset*:
    one of: number | "Infinity" | "-Infinity" | "NaN"

DashboardJob

  • id*:string
  • projectId*:string
  • projectSlug*:string
  • customKey*:string | null
  • title*:string | null
  • status*:"registered" | "queued" | "running" | "completed" | "cancelled" | "skipped" | "retrying"
  • scheduledAt*:string
  • httpUrl*:string
  • httpMethod*:string
  • httpHeaders*:object
  • registeredAt*:string
  • cancelledAt*:string | null
  • httpBodyPreview*:string | null
  • httpBodySize*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • queuedAt*:string | null
  • startedAt*:string | null
  • completedAt*:string | null
  • responseStatus*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • errorMessage*:string | null
  • rateLimitedAt*:string | null
  • rateLimitedUntil*:string | null
  • rateLimitedTags*:string[]
  • attemptNumber*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
    | null
  • lastActivityAt*:string
  • generatorId*:string | null
  • generatorCustomKey*:string | null
  • generatorStatus*:string | null
  • tags*:string[]

CreateKeyResponse

ApiKey

  • id*:string
  • projectId*:string
  • name*:string
  • keyValue*:string
  • createdAt*:string

ListKeysResponse

BulkResponse

DeclareOperationResult

  • operation*:"unchanged" | "added" | "skipped" | "updated" | "cancelled"
  • customKey*:string | null
  • kind*:"job" | "generator"
  • id*:string
  • changedFields?:string[] | null

DeclareSummary

  • unchanged*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • added*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • skipped*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • updated*:
    one of: number | "Infinity" | "-Infinity" | "NaN"
  • cancelled*:
    one of: number | "Infinity" | "-Infinity" | "NaN"

BulkRequest

  • runMissed?:boolean | null
  • upserts?:JobDeclaration[] | null
  • cancels?:
    one of: string |
    • customKey*:string
     |
    • id*:string
     |
    • tag*:string
    []     | null

JobDeclaration

  • customKey?:string | null
  • title?:string | null
  • scheduledAt?:string | null
  • url*:string
  • method?:string | null
  • headers?:object | null
  • body?:
    one of:
    • _tag*:"base64"
    • value*:string
     |
    • _tag*:"text"
    • value*:string
     | any
    | null
  • tags?:string[] | null

DeclareResponse

DeclareRequest

Gone

  • _tag*:"Gone"
  • message*:string

QuotaExceeded

  • _tag*:"QuotaExceeded"
  • message*:string

ScheduleResult

  • triggerId*:string
  • scheduledAt*:string
  • operation*:"schedule" | "reschedule"
  • kind*:"job" | "generator"
  • monthQuotaRemaining*:
    one of: number | "Infinity" | "-Infinity" | "NaN"