curl --request POST \
--url https://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "<string>",
"eventTypes": [],
"allInboxes": true,
"mailboxIds": [
"<string>"
]
}
'import requests
url = "https://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks"
payload = {
"url": "<string>",
"eventTypes": [],
"allInboxes": True,
"mailboxIds": ["<string>"]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({url: '<string>', eventTypes: [], allInboxes: true, mailboxIds: ['<string>']})
};
fetch('https://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks', 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://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks",
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([
'url' => '<string>',
'eventTypes' => [
],
'allInboxes' => true,
'mailboxIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$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://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"eventTypes\": [],\n \"allInboxes\": true,\n \"mailboxIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
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://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"eventTypes\": [],\n \"allInboxes\": true,\n \"mailboxIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"eventTypes\": [],\n \"allInboxes\": true,\n \"mailboxIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"urlHost": "<string>",
"eventTypes": [
"message.received"
],
"allInboxes": true,
"mailboxIds": [
"<string>"
],
"status": "active",
"hasAuthorization": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"signingSecret": "<string>"
}Create webhook
Plans: Free · Developer · Enterprise
Workspace admins only. Normal management request limits and accounting apply; no webhook delivery fee. Destinations receive selected email content. URLs and Authorization values are write-only. Signing secrets are returned only by create and rotate. Deliveries are at least once, unordered, with a stable event ID. Failed transient requests retry for approximately 24 hours. History is retained for 7 days.
curl --request POST \
--url https://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "<string>",
"eventTypes": [],
"allInboxes": true,
"mailboxIds": [
"<string>"
]
}
'import requests
url = "https://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks"
payload = {
"url": "<string>",
"eventTypes": [],
"allInboxes": True,
"mailboxIds": ["<string>"]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({url: '<string>', eventTypes: [], allInboxes: true, mailboxIds: ['<string>']})
};
fetch('https://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks', 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://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks",
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([
'url' => '<string>',
'eventTypes' => [
],
'allInboxes' => true,
'mailboxIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$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://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"eventTypes\": [],\n \"allInboxes\": true,\n \"mailboxIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
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://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"eventTypes\": [],\n \"allInboxes\": true,\n \"mailboxIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/workspaces/{workspaceId}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"eventTypes\": [],\n \"allInboxes\": true,\n \"mailboxIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"urlHost": "<string>",
"eventTypes": [
"message.received"
],
"allInboxes": true,
"mailboxIds": [
"<string>"
],
"status": "active",
"hasAuthorization": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"signingSecret": "<string>"
}Authorizations
API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.
Headers
Reuse only for the identical request after an uncertain response.
1 - 128^[A-Za-z0-9._:-]+$Path Parameters
Body
Public HTTPS destination. Credentials, fragments, private addresses and redirects are rejected. Write-only.
40961 - 5 elementsmessage.received, message.sent, message.delivered, message.bounced, message.complained Includes future inboxes. When false select mailboxIds explicitly.
500Optional Authorization header; null clears it. Never returned.
4096Response
Result including signingSecret once. Save it securely; list/get never return it.
1 - 5 elementsmessage.received, message.sent, message.delivered, message.bounced, message.complained Includes future inboxes. When false select mailboxIds explicitly.
500active, paused, disabled, deleted Returned once on initial creation or rotation. Omitted on idempotent creation replay. Save securely.
^whsec_Was this page helpful?