POST /api/me/heartbeat

Account required · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.
Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.

Request

Parameter	Location	Type and requirement
`Origin`	header	string · required An origin allowed by this deployment.
`X-CSRF-Token`	header	string · required Must match the CSRF cookie issued to this browser.

Body · application/json

sessionId required · string

active optional · boolean

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

Save as request.json

{
  "sessionId": "1"
}

cURL (POSIX shell)

curl --include \
  --request POST \
  'https://api.weavers.app/api/me/heartbeat' \
  --cookie cookies.txt --cookie-jar cookies.txt \
  --header 'Origin: https://weavers.app' \
  --header "X-CSRF-Token: ${CSRF_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "status": "example",
  "activity": {
    "localDate": "2025-01-01",
    "activeSeconds": 1,
    "addedSeconds": 1,
    "thresholdSeconds": 1,
    "awarded": false,
    "reward": 1,
    "coinBalance": null
  },
  "dailyLogin": null,
  "streak": null
}

View response model

status required · string

activity required · object

View activity model

localDate required · string

activeSeconds required · number

addedSeconds required · number

thresholdSeconds required · number

awarded required · boolean

reward required · number

coinBalance required · null | number

View coinBalance model

Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

dailyLogin required · null | object

View dailyLogin model

Variant 1: null

null

Variant 2: object

awarded required · boolean

reward required · number

balance required · null | number

View balance model

Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

streak required · null | object

View streak model

Variant 1: null

null

Variant 2: object

status required · "updated"

streakCount required · number

lastActiveDate required · string

awarded required · boolean

reward required · number

Additional fields: JSON values.

Variant 3: object

status required · "no_op"

streakCount required · number

lastActiveDate required · string

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data

{
  "error": "example"
}

View response model

error required · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

404 · Resource or enabled capability not found.

application/json

404 example · synthetic data

{
  "error": "example"
}

View response model

error required · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data

{
  "error": "example"
}

View response model

Variant 1: object

error required · string

Additional fields: JSON values.

Variant 2: object

Additional fields: JSON value.