API reference · Flintwake

Base URL and authentication

Every request goes to the host for its environment and carries a bearer token. Keys are environment-scoped: a sandbox key cannot read production wakes, whatever scopes it holds.

Every request

curl https://api.flintwake.com/v2/wakes \
  -H "Authorization: Bearer $FLINTWAKE_API_KEY" \
  -H "Accept: application/json"

Endpoints

Resource reference

10 of 10 endpoints

Returns a cursor-paginated list of wakes, newest first. Filters compose: every parameter you add narrows the result. Wakes are retained for the period configured on the environment.

Required scope: wakes:read

Parameters

Parameters for GET /v2/wakes
Name	Type	Description
`environment`	string	Environment name. Defaults to the key's own environment.
`status`	integer	Exact HTTP status to match, for example 500.
`status_class`	enum	One of 2xx, 3xx, 4xx or 5xx. Mutually exclusive with status.
`path`	string	Path template to match, for example /v2/payments/intents.
`consumer`	string	Consumer identifier or name.
`min_latency_ms`	integer	Only return wakes slower than this many milliseconds.
`limit`	integer	Between 1 and 100. Defaults to 20.
`cursor`	string	Opaque cursor returned as next_cursor by the previous page.

Responses

200A list of wakes with a cursor for the next page.
401The key is missing, malformed or revoked.
403The key does not carry the wakes:read scope.

Request

curl https://api.flintwake.com/v2/wakes?status_class=5xx&limit=20 \
  -H "Authorization: Bearer $FLINTWAKE_API_KEY"

Example response

{
  "object": "list",
  "has_more": true,
  "next_cursor": "cur_8f2a",
  "data": [
    {
      "id": "wk_0c41f2f4",
      "method": "GET",
      "path": "/v2/reports/settlements",
      "status": 504,
      "latency_ms": 30012,
      "consumer": "Pelham Freight",
      "region": "syd1",
      "captured_at": "2026-09-16T12:04:16.312Z"
    }
  ]
}

Errors

Every type we return

Branch on type, never on message.

Error types, their HTTP status and the expected recovery.
Type	Status	Recovery
`invalid_request`	400	Fix the request shape. The param field names the offending key.
`authentication_required`	401	Send an Authorization header with a live key.
`key_revoked`	401	Issue a replacement key. Revocation is not reversible.
`insufficient_scope`	403	Reissue the key with the scope named in the message.
`resource_missing`	404	Check the identifier and the environment. Identifiers are environment-scoped.
`conflict`	409	Re-read the resource and retry with the current version.
`unprocessable`	422	The shape is valid but the values are not. See param.
`rate_limit_exceeded`	429	Back off for retry_after seconds. Do not retry immediately.
`internal_error`	500	Retry once with backoff, then report the wake_id to support.
`upstream_timeout`	504	Your origin did not answer in time. Retry is safe for idempotent calls.

Events

Webhook event types

Subscribe to what you need, or to everything.

wake.error
A captured request returned a 5xx status.
wake.slow
A captured request exceeded the endpoint's latency objective.
replay.finished
A replay completed. The payload carries the response diff.
consumer.quota.warning
A consumer crossed 80% or 95% of its allowance.
slo.burn
An availability or latency objective is burning error budget too fast.
key.rotated
A key was issued as a replacement for another key.
key.revoked
A key was revoked, manually or on schedule.
webhook.disabled
An endpoint was disabled after seven days of 410 responses.

Rate limits

Default rate limits by scope and window.
Scope	Window	Limit	Burst	Note
Default consumer	per minute	6,000	9,000	Applies to every key without an override.
Reports endpoints	per minute	600	600	Report generation is deliberately slower and cheaper.
Webhook registration	per hour	120	120	Protects consumers from accidental fan-out.
Sandbox	per minute	1,200	1,200	Shared across every sandbox key on the account.

Rate limit headers on every response

x-ratelimit-limit: 6000
x-ratelimit-remaining: 5842
x-ratelimit-reset: 38
retry-after: 12

Try any of these endpoints without writing code.

The playground runs the same operations against sandbox fixtures and writes the snippet for you.

Open the playground Install an SDK

Ten endpoints, documented the way you want yours documented.

Base URL and authentication

Resource reference

GET/v2/wakesWakesList captured requests

Parameters

Responses

GET/v2/wakes/{wake_id}WakesRetrieve one wake

POST/v2/wakes/{wake_id}/replayWakesReplay a wake

GET/v2/endpointsEndpointsList endpoint health

GET/v2/consumersConsumersList consumers

POST/v2/api-keysKeysCreate an API key

DELETE/v2/api-keys/{key_id}KeysRevoke an API key

POST/v2/webhooks/endpointsWebhooksCreate a webhook endpoint

POST/v2/webhooks/deliveries/{delivery_id}/replayWebhooksReplay a webhook delivery

POST/v2/deploysDeploysRecord a deploy

Every type we return

Webhook event types

Rate limits

Try any of these endpoints without writing code.