For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
contact@agentmail.ccDiscord
DocumentationAPI ReferenceKnowledge BaseChangelog
DocumentationAPI ReferenceKnowledge BaseChangelog
  • API Reference
      • GETList Webhooks
      • GETGet Webhook
      • POSTCreate Webhook
      • PATCHUpdate Webhook
      • DELDelete Webhook
        • POSTMessage Received
        • POSTMessage Sent
        • POSTMessage Delivered
        • POSTMessage Bounced
        • POSTMessage Complained
        • POSTMessage Rejected
        • POSTDomain Verified
LogoLogo
contact@agentmail.ccDiscord
API ReferenceWebhooksEvents

Message Received

Payload
1{
2  "type": "event",
3  "event_type": "message.received",
4  "event_id": "string",
5  "message": {
6    "inbox_id": "string",
7    "thread_id": "string",
8    "message_id": "string",
9    "labels": [
10      "string"
11    ],
12    "timestamp": "2023-01-01T00:00:00Z",
13    "from": "string",
14    "to": [
15      "string"
16    ],
17    "size": 0,
18    "updated_at": "2023-01-01T00:00:00Z",
19    "created_at": "2023-01-01T00:00:00Z",
20    "reply_to": [
21      "string"
22    ],
23    "cc": [
24      "string"
25    ],
26    "bcc": [
27      "string"
28    ],
29    "subject": "string",
30    "preview": "string",
31    "text": "string",
32    "html": "string",
33    "extracted_text": "string",
34    "extracted_html": "string",
35    "attachments": [
36      {
37        "attachment_id": "string",
38        "size": 0,
39        "filename": "string",
40        "content_type": "string",
41        "content_disposition": "inline",
42        "content_id": "string"
43      }
44    ],
45    "in_reply_to": "string",
46    "references": [
47      "string"
48    ],
49    "headers": {
50      "string": "string"
51    }
52  },
53  "thread": {
54    "inbox_id": "string",
55    "thread_id": "string",
56    "labels": [
57      "string"
58    ],
59    "timestamp": "2023-01-01T00:00:00Z",
60    "senders": [
61      "string"
62    ],
63    "recipients": [
64      "string"
65    ],
66    "last_message_id": "string",
67    "message_count": 0,
68    "size": 0,
69    "updated_at": "2023-01-01T00:00:00Z",
70    "created_at": "2023-01-01T00:00:00Z",
71    "received_timestamp": "2023-01-01T00:00:00Z",
72    "sent_timestamp": "2023-01-01T00:00:00Z",
73    "subject": "string",
74    "preview": "string",
75    "attachments": [
76      {
77        "attachment_id": "string",
78        "size": 0,
79        "filename": "string",
80        "content_type": "string",
81        "content_disposition": "inline",
82        "content_id": "string"
83      }
84    ]
85  }
86}
Was this page helpful?
Previous

Message Sent

Next
Built with

Headers

svix-idstringRequired
ID of webhook message.
svix-signaturestringRequired
Signature of webhook message.
svix-timestampdatetimeRequired
Timestamp of webhook message.

Payload

The payload of this webhook request is an object.
type"event"Required
event_typeenumRequired
Allowed values:
event_idstringRequired
ID of event.
messageobjectRequired
threadobjectRequired

Response

200
any
Return a 200 status to indicate that the data was received successfully.