GET
/
api
/
v2
/
endpoints
/
{id}
GET https://inbound.new/api/v2/endpoints/{id}
{
  "id": "ep_abc123",
  "name": "Production Webhook",
  "type": "webhook",
  "config": {
    "url": "https://api.example.com/webhook",
    "timeout": 30,
    "retryAttempts": 3,
    "headers": {
      "X-Custom-Header": "value"
    }
  },
  "isActive": true,
  "description": "Main webhook for production alerts",
  "userId": "user_123",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "groupEmails": null,
  "deliveryStats": {
    "total": 145,
    "successful": 142,
    "failed": 3,
    "lastDelivery": "2024-01-15T14:30:00Z"
  },
  "recentDeliveries": [
    {
      "id": "del_xyz789",
      "emailId": "email_456",
      "deliveryType": "webhook",
      "status": "success",
      "attempts": 1,
      "lastAttemptAt": "2024-01-15T14:30:00Z",
      "createdAt": "2024-01-15T14:30:00Z",
      "responseData": {
        "responseCode": 200,
        "responseBody": "OK",
        "deliveryTime": 250,
        "url": "https://api.example.com/webhook"
      }
    }
  ],
  "associatedEmails": [
    {
      "id": "addr_123",
      "address": "alerts@example.com",
      "isActive": true,
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "catchAllDomains": [
    {
      "id": "dom_456",
      "domain": "example.com",
      "status": "ses_verified"
    }
  ]
}

Overview

Get comprehensive information about a specific endpoint including its configuration, delivery statistics, recent deliveries, associated email addresses, and catch-all domain configurations.
GET https://inbound.new/api/v2/endpoints/{id}

Authentication

Authorization
string
required
Bearer token for API authentication. Format: Bearer YOUR_API_KEY

Path Parameters

id
string
required
The unique identifier of the endpoint to retrieve.

Response

{
  "id": "ep_abc123",
  "name": "Production Webhook",
  "type": "webhook",
  "config": {
    "url": "https://api.example.com/webhook",
    "timeout": 30,
    "retryAttempts": 3,
    "headers": {
      "X-Custom-Header": "value"
    }
  },
  "isActive": true,
  "description": "Main webhook for production alerts",
  "userId": "user_123",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "groupEmails": null,
  "deliveryStats": {
    "total": 145,
    "successful": 142,
    "failed": 3,
    "lastDelivery": "2024-01-15T14:30:00Z"
  },
  "recentDeliveries": [
    {
      "id": "del_xyz789",
      "emailId": "email_456",
      "deliveryType": "webhook",
      "status": "success",
      "attempts": 1,
      "lastAttemptAt": "2024-01-15T14:30:00Z",
      "createdAt": "2024-01-15T14:30:00Z",
      "responseData": {
        "responseCode": 200,
        "responseBody": "OK",
        "deliveryTime": 250,
        "url": "https://api.example.com/webhook"
      }
    }
  ],
  "associatedEmails": [
    {
      "id": "addr_123",
      "address": "alerts@example.com",
      "isActive": true,
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "catchAllDomains": [
    {
      "id": "dom_456",
      "domain": "example.com",
      "status": "ses_verified"
    }
  ]
}

Response Fields

id
string
Unique identifier for the endpoint.
name
string
User-friendly name for the endpoint.
type
string
Type of endpoint: webhook, email, or email_group.
config
object
Configuration object specific to the endpoint type.
isActive
boolean
Whether the endpoint is active and will receive emails.
description
string | null
Description of the endpoint.
userId
string
ID of the user who owns this endpoint.
createdAt
string
ISO 8601 timestamp when the endpoint was created.
updatedAt
string
ISO 8601 timestamp when the endpoint was last updated.
groupEmails
string[] | null
Array of email addresses (only for email_group type endpoints).
deliveryStats
object
Statistics about email deliveries to this endpoint.
recentDeliveries
array
Array of the 10 most recent delivery attempts.
associatedEmails
array
Array of email addresses that route to this endpoint.
catchAllDomains
array
Array of domains that use this endpoint for catch-all routing.

Examples

Get Webhook Endpoint

curl -X GET "https://inbound.new/api/v2/endpoints/ep_abc123" \
  -H "Authorization: Bearer your_api_key"

Get Email Group Endpoint

curl -X GET "https://inbound.new/api/v2/endpoints/ep_def456" \
  -H "Authorization: Bearer your_api_key"

Error Responses

Understanding the Response

For webhook endpoints, the config object contains:
  • url - The webhook destination URL
  • timeout - Request timeout in seconds
  • retryAttempts - Number of retry attempts
  • headers - Custom headers to include in requests
  • secret - Webhook secret for signature verification

Delivery Statistics

The deliveryStats object provides insights into how the endpoint is performing:

Success Rate

successful / total * 100 gives you the success percentage

Recent Activity

lastDelivery shows when the endpoint was last used

Recent Deliveries

The recentDeliveries array shows the 10 most recent delivery attempts, including:
  • Success/failure status
  • Response data (for webhooks)
  • Delivery timing information
  • Number of attempts made
This information is useful for debugging delivery issues or monitoring endpoint performance.