Flambe docs
API referenceTimers

Cancel a timer

PATCH
/api/timers/{timerId}/cancel

Authorization

bearerAuth
AuthorizationBearer <token>

A Clerk session JWT. Obtain one with a Clerk frontend SDK (session.getToken()) or, for server-to-server use, with a Clerk machine token. The token's sub claim is the Flambe user id that scopes every request.

In: header

Path Parameters

timerId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/timers/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"
{  "timerId": "c48c1954-3e81-466f-bee5-92209379c29b",  "title": "Rest the dough",  "dueAt": "2019-08-24T14:15:22Z",  "status": "scheduled",  "remainingMs": 0,  "payload": {},  "deliveryPrefs": {    "push": true,    "sound": "string"  },  "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",  "recipeId": "31545f76-b27f-4c7c-9faf-229771396df1",  "contextType": "string",  "contextId": "string",  "idempotencyKey": "string",  "ttl": 0,  "createdAt": "2019-08-24T14:15:22Z"}

Acknowledge a fired timer POST

Confirms the user saw the alert, which stops further reminders for it.

Create a timer POST

Schedules a timer to fire at `dueAt`. Because the schedule lives on the server, it still fires if the app is backgrounded or the device restarts. Pass `idempotencyKey` to make retries safe — a second call with the same key returns the original timer rather than creating a duplicate. Note that timer fields are `camelCase`, unlike the rest of the API.