Skip to content
FilemonkDevelopers
Open Filemonk

Resource

View as Markdown

Emails

Every email Filemonk sent and how far it got.

The email object

Attributes

  • idstring, nullable
    Example: 77c81a2e-4221-4a03-b784-221de4b1bf5c
  • kindstring, nullable
    Example: delivery
  • tostring, nullable
    Example: shopper@example.com
  • fromstring, nullable
    Example: alerts@example-store.filemonk.io
  • orderobject
    Show 2 child attributesHide child attributes
    • idstring, nullable
      Example: 3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f
    • namestring, nullable
      Example: #1077
  • statusstring, nullable
    Example: delivered
  • timelineobject
    Show 7 child attributesHide child attributes
    • sent_atstring, nullable
      Example: 2026-10-30T23:02:25Z
    • delivered_atstring, nullable
      Example: 2026-10-30T23:02:24Z
    • opened_atany
    • clicked_atany
    • bounced_atany
    • rejected_atany
    • complained_atany
  • created_atstring, nullable
    Example: 2026-10-30T23:02:24Z
Endpoints
The email object
{
  "id": "77c81a2e-4221-4a03-b784-221de4b1bf5c",
  "kind": "delivery",
  "to": "shopper@example.com",
  "from": "alerts@example-store.filemonk.io",
  "order": {
    "id": "3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f",
    "name": "#1077"
  },
  "status": "delivered",
  "timeline": {
    "sent_at": "2026-10-30T23:02:25Z",
    "delivered_at": "2026-10-30T23:02:24Z",
    "opened_at": null,
    "clicked_at": null,
    "bounced_at": null,
    "rejected_at": null,
    "complained_at": null
  },
  "created_at": "2026-10-30T23:02:24Z"
}