Skip to content
Kindgi

A mail trigger's mail

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

Newest first: each mail the trigger found and what came of it (MailFire): the run it started, why it waits (thread-busy:), or why it was skipped, refused or failed.

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 the trigger’s mail.

Media typeapplication/json
object
data
required
Array<object>

One mail a mail trigger found and what came of it. A thread’s mail runs one at a time, oldest first.

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

pending while its run starts, or while an earlier mail of its thread waits or that mail’s run hasn’t finished (detail starts thread-busy:). skipped: no run started, as detail says: the mail is from the mailbox’s own address (own-address), an automatic reply (auto-submitted), received before the trigger began watching (before-since), found in a mailbox that changed account before it was read (mailbox-changed), gone by the time it was read (not-found), or already had by an earlier run of its thread (mail-already-given:); or the poll started afresh (cursor-reset:). refused: over the trigger’s runsPerHour (over-limit:), the mailbox’s connection missing, lapsed or lacking a scope (connection-missing: and why), or the app gave the mail no thread (no-thread-id); a refused mail doesn’t run later. failed: the run couldn’t start.

string
Allowed values: pending started skipped refused failed
runId

The run it started.

string format: uuid
version

The trigger’s version its run started with: the newest when it started. Absent until the run starts.

integer
>= 1
detail

Why it was skipped, refused or failed, or why a pending fire waits.

string
countsTowardPause

Whether this fire counted toward the trigger’s auto-pause (5 in a row by default). false for over-limit:, connection-missing: and no-thread-id refusals: the limit passes, connecting again ends a missing connection, and a mail with no thread is the app’s doing, not the trigger’s. Skips never count.

boolean
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 mail 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 fire 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"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

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