Fetch all events history for one particular received email.

GET

https://api.brevo.com/v3/inbound/events/:uuid

GET

/v3/inbound/events/:uuid

1 import { BrevoClient } from "@getbrevo/brevo";
2 
3 async function main() {
4     const client = new BrevoClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.inboundParsing.getInboundEmailEventsByUuid("uuid");
8 }
9 main();

1 {
2   "attachments": [
3     {
4       "contentLength": 12345,
5       "contentType": "application/pdf",
6       "name": "invoice.pdf"
7     }
8   ],
9   "deliveredAt": "2017-03-12T12:31:00.000Z",
10   "logs": [
11     {
12       "date": "2017-03-12T12:30:00.000Z",
13       "type": "received"
14     },
15     {
16       "date": "2017-03-12T12:30:04.000Z",
17       "type": "webhookFailed"
18     },
19     {
20       "date": "2017-03-12T12:31:04.000Z",
21       "type": "webhookDelivered"
22     }
23   ],
24   "messageId": "<a_nice@message.id>",
25   "receivedAt": "2017-03-12T12:30:00.000Z",
26   "recipient": "bob@example.com",
27   "sender": "alice@example.com",
28   "subject": "Re: Question about your API"
29 }

This endpoint will show the list of all events history for one particular received email.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

uuidstringRequired

UUID to fetch events specific to received email

Response

Detailed information and event history for the specified received email.

attachmentslist of objectsOptional

List of attachments of the email. This will be present only after the processing is done.

deliveredAtdatetime or nullOptional

Date when email was delivered successfully to the client’s webhook

logslist of objectsOptional

List of events/logs that describe the lifecycle of the email on the Brevo platform

messageIdstringOptional

Value of the Message-ID header. This will be present only after the processing is done.

receivedAtdatetimeOptional

Date when email was received on SMTP relay

recipientstringOptionalformat: "email"

Recipient’s email address

senderstringOptionalformat: "email"

Sender’s email address

subjectstringOptional

Value of the Subject header. This will be present only after the processing is done.

Errors

400

Bad Request Error

404

Not Found Error