Endpoints
Create new endpoint
Create a new endpoint (webhook, email, or email_group) for the authenticated user
POST
/
api
/
e2
/
endpoints
TypeScript
import Inbound from "inboundemail";
const inbound = new Inbound();
const result = await inbound.endpoints.create({
name: "Support",
type: "webhook",
config: {
url: "https://example.com/webhooks/inbound"
}
});curl -X POST 'https://inbound.new/api/e2/endpoints' \
-H "Authorization: Bearer $INBOUND_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"name": "Support",
"type": "webhook",
"config": {
"url": "https://example.com/webhooks/inbound"
}
}'import requests
url = "https://inbound.new/api/e2/endpoints"
payload = {
"name": "<string>",
"config": {
"url": "<string>",
"timeout": 15.5,
"retryAttempts": 5,
"headers": {}
},
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
config: {url: '<string>', timeout: 15.5, retryAttempts: 5, headers: {}},
description: '<string>'
})
};
fetch('https://inbound.new/api/e2/endpoints', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://inbound.new/api/e2/endpoints",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'config' => [
'url' => '<string>',
'timeout' => 15.5,
'retryAttempts' => 5,
'headers' => [
]
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://inbound.new/api/e2/endpoints"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {\n \"url\": \"<string>\",\n \"timeout\": 15.5,\n \"retryAttempts\": 5,\n \"headers\": {}\n },\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://inbound.new/api/e2/endpoints")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {\n \"url\": \"<string>\",\n \"timeout\": 15.5,\n \"retryAttempts\": 5,\n \"headers\": {}\n },\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inbound.new/api/e2/endpoints")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"config\": {\n \"url\": \"<string>\",\n \"timeout\": 15.5,\n \"retryAttempts\": 5,\n \"headers\": {}\n },\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123
}Authorizations
Your Inbound API key. Include it in the Authorization header as: Bearer
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
Response for status 201
Available options:
webhook, email, email_group Show child attributes
Show child attributes
Was this page helpful?
⌘I
TypeScript
import Inbound from "inboundemail";
const inbound = new Inbound();
const result = await inbound.endpoints.create({
name: "Support",
type: "webhook",
config: {
url: "https://example.com/webhooks/inbound"
}
});curl -X POST 'https://inbound.new/api/e2/endpoints' \
-H "Authorization: Bearer $INBOUND_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"name": "Support",
"type": "webhook",
"config": {
"url": "https://example.com/webhooks/inbound"
}
}'import requests
url = "https://inbound.new/api/e2/endpoints"
payload = {
"name": "<string>",
"config": {
"url": "<string>",
"timeout": 15.5,
"retryAttempts": 5,
"headers": {}
},
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
config: {url: '<string>', timeout: 15.5, retryAttempts: 5, headers: {}},
description: '<string>'
})
};
fetch('https://inbound.new/api/e2/endpoints', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://inbound.new/api/e2/endpoints",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'config' => [
'url' => '<string>',
'timeout' => 15.5,
'retryAttempts' => 5,
'headers' => [
]
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://inbound.new/api/e2/endpoints"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {\n \"url\": \"<string>\",\n \"timeout\": 15.5,\n \"retryAttempts\": 5,\n \"headers\": {}\n },\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://inbound.new/api/e2/endpoints")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {\n \"url\": \"<string>\",\n \"timeout\": 15.5,\n \"retryAttempts\": 5,\n \"headers\": {}\n },\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inbound.new/api/e2/endpoints")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"config\": {\n \"url\": \"<string>\",\n \"timeout\": 15.5,\n \"retryAttempts\": 5,\n \"headers\": {}\n },\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123
}