Create a sandbox webhook
/api/v1/sandbox/webhooksReturns the signing secret once. Omit inbox_id to receive events for every inbox. Addresses on private, loopback or internal networks are refused. Send to a simulator address (bounce@sim.mailyte.com, softbounce@, complaint@, suppressed@) to fire the failure events. Owners and admins only.
Request body
urlstringrequiredThe full HTTPS address we send to. It must be reachable from the internet.
eventsarray<string>requiredThe events to receive.
sandbox.testis the onePOST /sandbox/webhooks/{id}/testsends.inbox_idstringOptional. The ID of one Sandbox inbox. Leave it out to cover every inbox.
Request
/api/v1/sandbox/webhookscurl -X POST 'https://app.mailyte.com/api/v1/sandbox/webhooks' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://example.com/webhooks/mailyte",
"events": [
"email.delivered",
"email.bounced"
]
}'const response = await fetch('https://app.mailyte.com/api/v1/sandbox/webhooks', {
method: 'POST',
headers: {
Authorization: 'Bearer mk_live_YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"url": "https://example.com/webhooks/mailyte",
"events": [
"email.delivered",
"email.bounced"
]
}),
});
const { data } = await response.json();import requests
response = requests.post(
"https://app.mailyte.com/api/v1/sandbox/webhooks",
headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
json={
"url": "https://example.com/webhooks/mailyte",
"events": [
"email.delivered",
"email.bounced"
]
},
)
data = response.json()["data"]<?php
$response = Http::withToken('mk_live_YOUR_API_KEY')
->post('https://app.mailyte.com/api/v1/sandbox/webhooks', [
'url' => 'https://example.com/webhooks/mailyte',
'events' => [
'email.delivered',
'email.bounced',
],
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/sandbox/webhooks")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
"url": "https://example.com/webhooks/mailyte",
"events": [
"email.delivered",
"email.bounced"
]
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Success.
dataobjectidstringorganization_idstringinbox_idstringThe inbox whose messages trigger it. Null means every inbox in your account.
urlstringeventsarray<string>statusstringactive | disabledcreated_atstringWhen it was created.
updated_atstringWhen it was last changed.
secretstringThe secret for checking signatures, shown only when the webhook is created. It is separate from your live webhooks' secrets. Sandbox deliveries also carry
environment: "sandbox"and anX-Webhook-Environment: sandboxheader.
application/json{
"url": "https://example.com/hooks/mailyte",
"events": [
"email.delivered",
"email.bounced"
]
}Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.