Skip to main content
POST
/
api
/
e2
/
endpoints
/
{id}
/
test
JavaScript
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);
{
  "success": true,
  "message": "<string>",
  "responseTime": 123,
  "statusCode": 123,
  "responseBody": "<string>",
  "error": "<string>",
  "testPayload": "<unknown>",
  "webhookFormat": "inbound",
  "urlTested": "<string>"
}

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Path Parameters

id
string
required

Body

webhookFormat
enum<string>
Available options:
inbound,
discord,
slack
overrideUrl
string

Response

Response for status 200

success
boolean
required
message
string
required
responseTime
number
required
statusCode
number
responseBody
string
error
string
testPayload
any
webhookFormat
enum<string>
Available options:
inbound,
discord,
slack
urlTested
string