import Inbound from 'inboundemail';
const client = new Inbound({
apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
});
const endpoint = await client.endpoints.retrieve('id');
console.log(endpoint.id);{
"id": "<string>",
"name": "<string>",
"type": "webhook",
"config": "<unknown>",
"isActive": true,
"description": "<string>",
"userId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"groupEmails": [
"<string>"
],
"deliveryStats": {
"total": 123,
"successful": 123,
"failed": 123,
"lastDelivery": "<string>"
},
"recentDeliveries": [
{
"id": "<string>",
"emailId": "<string>",
"deliveryType": "<string>",
"status": "<string>",
"attempts": 123,
"lastAttemptAt": "<string>",
"responseData": "<unknown>",
"createdAt": "<string>"
}
],
"associatedEmails": [
{
"id": "<string>",
"address": "<string>",
"isActive": true,
"createdAt": "<string>"
}
],
"catchAllDomains": [
{
"id": "<string>",
"domain": "<string>",
"status": "<string>"
}
]
}Get detailed information about a specific endpoint including delivery stats, recent deliveries, associated emails, and catch-all domains
import Inbound from 'inboundemail';
const client = new Inbound({
apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
});
const endpoint = await client.endpoints.retrieve('id');
console.log(endpoint.id);{
"id": "<string>",
"name": "<string>",
"type": "webhook",
"config": "<unknown>",
"isActive": true,
"description": "<string>",
"userId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"groupEmails": [
"<string>"
],
"deliveryStats": {
"total": 123,
"successful": 123,
"failed": 123,
"lastDelivery": "<string>"
},
"recentDeliveries": [
{
"id": "<string>",
"emailId": "<string>",
"deliveryType": "<string>",
"status": "<string>",
"attempts": 123,
"lastAttemptAt": "<string>",
"responseData": "<unknown>",
"createdAt": "<string>"
}
],
"associatedEmails": [
{
"id": "<string>",
"address": "<string>",
"isActive": true,
"createdAt": "<string>"
}
],
"catchAllDomains": [
{
"id": "<string>",
"domain": "<string>",
"status": "<string>"
}
]
}Your Inbound API key. Include it in the Authorization header as: Bearer
Response for status 200
webhook, email, email_group Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?