> ## Documentation Index
> Fetch the complete documentation index at: https://inbound.new/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Test endpoint

> Test an endpoint by sending a test payload. For webhooks, supports inbound, discord, and slack formats. For email endpoints, simulates the forwarding process.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/inbound/openapi.documented.yml post /api/e2/endpoints/{id}/test
openapi: 3.1.0
info:
  title: Inbound Email API
  description: >+

    # Inbound API


    The Inbound API allows you to manage email infrastructure programmatically -
    domains, email addresses, webhooks, and more.


    ## Authentication


    All API requests require a Bearer token in the Authorization header:


    ```bash

    curl -H "Authorization: Bearer YOUR_API_KEY" \
      https://inbound.new/api/e2/domains
    ```


    ## Base URL


    ```

    https://inbound.new/api/e2

    ```


    ## Quick Start


    1. **Create a domain** - Register your domain with Inbound

    2. **Configure DNS** - Add the provided DNS records to your domain

    3. **Create an email address** - Set up addresses to receive emails

    4. **Create an endpoint** - Configure where emails are delivered (webhook,
    forwarding, etc.)

  version: 2.0.0
servers:
  - url: https://inbound.new
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Webhooks
    description: Webhooks sent by Inbound to your configured endpoints when events occur.
  - name: Emails
    description: >-
      Send, list, and manage emails. Supports immediate sending, scheduling,
      replies, and retry functionality.
  - name: Mail
    description: >-
      Inbox and thread views for received emails. Filter by domain, address, or
      search.
  - name: Domains
    description: >-
      Manage domains for sending and receiving emails. Domains must be verified
      via DNS before use.
  - name: Endpoints
    description: >-
      Configure where incoming emails are delivered - webhooks, email
      forwarding, or custom handlers.
  - name: Email Addresses
    description: Create and manage email addresses on your verified domains.
  - name: Attachments
    description: Download email attachments using authenticated requests.
paths:
  /api/e2/endpoints/{id}/test:
    post:
      tags:
        - Endpoints
      summary: Test endpoint
      description: >-
        Test an endpoint by sending a test payload. For webhooks, supports
        inbound, discord, and slack formats. For email endpoints, simulates the
        forwarding process.
      operationId: postApiE2EndpointsByIdTest
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                webhookFormat:
                  type: string
                  enum:
                    - inbound
                    - discord
                    - slack
                overrideUrl:
                  type: string
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                webhookFormat:
                  type: string
                  enum:
                    - inbound
                    - discord
                    - slack
                overrideUrl:
                  type: string
          multipart/form-data:
            schema:
              type: object
              properties:
                webhookFormat:
                  type: string
                  enum:
                    - inbound
                    - discord
                    - slack
                overrideUrl:
                  type: string
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  responseTime:
                    type: number
                  statusCode:
                    type: number
                  responseBody:
                    type: string
                  error:
                    type: string
                  testPayload:
                    x-stainless-any: true
                  webhookFormat:
                    type: string
                    enum:
                      - inbound
                      - discord
                      - slack
                  urlTested:
                    type: string
                required:
                  - success
                  - message
                  - responseTime
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      error:
                        type: string
                      validFormats:
                        type: array
                        items:
                          type: string
                    required:
                      - error
                  - type: object
                    properties:
                      success:
                        const: false
                        type: boolean
                      message:
                        type: string
                      responseTime:
                        type: number
                    required:
                      - success
                      - message
                      - responseTime
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: number
                required:
                  - error
                  - message
                  - statusCode
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: number
                required:
                  - error
                  - message
                  - statusCode
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Inbound from 'inboundemail';

            const client = new Inbound({
              apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
            });

            const response = await client.endpoints.test('id');

            console.log(response.message);
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Your Inbound API key. Include it in the Authorization header as: Bearer
        <your-api-key>

````