Sent Emails

The SentEmailService provides read-only access to emails sent by the Firetiger platform (for example, issue and investigation notifications).

Service: firetiger.email.v1.SentEmailService

Resource name pattern: sent-emails/{sent_email}

Access: Read-only

Methods

Method Description
ListSentEmails List emails sent by the platform

ListSentEmails

List emails sent by the Firetiger platform, most recent first.

POST /firetiger.email.v1.SentEmailService/ListSentEmails

REST alternative:

GET /v1/sent-emails

Request body

Field Type Required Description
filter string No Filter expression (e.g. email_type = "EMAIL_TYPE_OVERAGE" or recipient = "user@example.com")
order_by string No Field to sort by (e.g. create_time desc)
page_size integer No Maximum number of emails to return
page_token string No Pagination token from a previous response
show_deleted boolean No Include soft-deleted rows

Example

curl -X POST "https://api.cloud.firetiger.com/firetiger.email.v1.SentEmailService/ListSentEmails" \
  -u "$USERNAME:$PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"page_size": 20}'

Response

{
  "sentEmails": [
    {
      "name": "sent-emails/em-abc123",
      "emailType": "EMAIL_TYPE_WELCOME",
      "recipient": "user@example.com",
      "deliveryProvider": "knock",
      "providerMessageId": "wr_2xYz9AbC",
      "createTime": "2024-06-15T14:30:00Z",
      "updateTime": "2024-06-15T14:30:00Z"
    }
  ],
  "nextPageToken": ""
}

SentEmail resource

Field Type Behavior Description
name string OUTPUT_ONLY Resource name (sent-emails/{id})
email_type EmailType   Type of email that was sent
recipient string   Recipient email address
resend_id string   Legacy Resend message ID. Populated only when delivery_provider = "resend"; new rows should read provider_message_id instead.
delivery_provider string   Provider that accepted the send request ("resend" or "knock")
provider_message_id string   Provider-specific message or workflow-run identifier for tracking (Resend message ID or Knock workflow-run ID)
create_time timestamp OUTPUT_ONLY When the row was recorded
update_time timestamp OUTPUT_ONLY When the row was last modified
delete_time timestamp OUTPUT_ONLY When the row was soft-deleted (null if active)

EmailType

Value Description
EMAIL_TYPE_UNSPECIFIED Default; should not appear in responses
EMAIL_TYPE_WELCOME New-user welcome email
EMAIL_TYPE_NO_BILLING Reminder that billing is not yet configured
EMAIL_TYPE_FIRST_AGENT_DRAFT_STALE Nudge when a first draft agent has gone stale
EMAIL_TYPE_FIRST_KNOWN_ISSUE Notification for the first issue detected
EMAIL_TYPE_DATA_NO_AGENT Data ingested but no agent configured
EMAIL_TYPE_OVERAGE First-of-billing-period overage notification
EMAIL_TYPE_AGENT_REVIEW_REQUIRED Agent draft awaiting human review
EMAIL_TYPE_WEEKLY_IMPACT_REPORT Weekly impact report digest

This site uses Just the Docs, a documentation theme for Jekyll.