Skip to content
Kindgi

A webhook trigger's deliveries

View as Markdown
GET
/v1/webhooks/{triggerId}/fires
curl --request GET \
  --url 'https://example.com/v1/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fires?limit=25' \
  --header 'Authorization: Bearer <token>'

Newest first: each delivery the trigger received and what came of it: the run it started (started, or pending while it starts), or why it was skipped (paused, its project or tenant suspended, or its tenant closing) or refused (detail: signature-missing, signature-invalid, stale, secret-unavailable, unregistered, rate-limited, body-too-large, body-not-json, body-too-deep, or the owner’s lost access). A delivery that repeated an earlier one’s dedupe key counts on that one (duplicates). A fire keeps the event only until its run starts. Refusals and skipped deliveries past 20 a minute only count (the trigger’s suppressedRefusals).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
triggerId
required
string format: uuid

TriggerId — the trigger id (a UUID).

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Where the previous page ended: its nextCursor, as it came. A runtime that seals cursors takes one only for the same list, filters and caller, within a day; otherwise 400 bad-input, and the list starts again without it. Absent → first page.

Responses

Section titled “Responses”

200

Section titled “200”

Page of deliveries.

Media typeapplication/json
object
data
required
Array<object>

One delivery to a webhook trigger and what came of it. A fire keeps the delivery’s event only until its run starts; then only the run has it.

object
fireId
required
string
triggerId
required
string
firedAt
required
string format: date-time
outcome
required

pending while its run starts. skipped: no run started, and the event was dropped: the trigger was paused (paused); its project was suspended after the delivery was taken, before its run started (project-suspended); its run hadn’t started when its tenant was suspended, and the restore concluded it (tenant-suspended); or its tenant was suspended or closing as its run started (tenant-suspended, tenant-closing). refused: detail says why. failed: the run couldn’t start.

string
Allowed values: pending started skipped refused failed
runId

The run it started.

string format: uuid
detail

Why it was refused, skipped or failed: signature-missing, signature-invalid, stale, secret-unavailable, unregistered, paused, rate-limited, body-too-large, body-not-json, body-too-deep, or the owner’s lost access. A skip for a suspension or a close names project-suspended, tenant-suspended or tenant-closing in it.

string
countsTowardPause

Whether this fire counted toward the trigger’s auto-pause (5 in a row by default). false for a refusal for a limit, such as the tenant’s runs pending (detail starts rate-limited:): the limit passes, and the trigger isn’t at fault. Absent from a runtime that doesn’t say: refused and failed fires counted, and the others didn’t.

boolean
duplicates

Later deliveries with the same dedupe key, which started nothing.

integer
>= 1
lastDuplicateAt
string format: date-time
hasMore
required
boolean
nextCursor
string
Example
{
  "data": [
    {
      "outcome": "pending"
    }
  ]
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No webhook trigger with that id.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

501

Section titled “501”

trigger-operation-unsupported: this deployment keeps no delivery history.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also