Leads

Subscribe an endpoint to receive captured leads

Register a public HTTPS URL to receive lead.created deliveries (a lead captured on one of your Mailr landing pages). Only landing-page leads fan out here — CRM-synced leads (see POST /api/v1/tracking/lead) never do, to avoid an echo loop.

The response returns a signing_secret exactly once, at creation. Store it: every delivery to a secret-bearing subscription is HMAC-signed (see the lead.created webhook below). Re-subscribing the same URL is idempotent — it returns the existing row’s id with signing_secret: null (secrets are never re-disclosed and never silently rotated, so a re-subscribe can’t break a receiver mid-flight and a compromised API key can’t recover live secrets). Lost the secret? POST /api/v1/webhooks/rotate mints a new one and returns it once. A subscription created before signing shipped is delivered unsigned; delete and re-subscribe (or rotate) to upgrade it.

The URL is SSRF-guarded at registration (public https only; hostname must resolve to public addresses) and again at delivery time.

POST

api

webhooks

Subscribe an endpoint to receive captured leads

curl --request POST \
  --url https://app.getmailr.com/api/v1/webhooks/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_url": "https://hooks.example.com/mailr/leads",
  "event": "lead.created"
}
'

import requests

url = "https://app.getmailr.com/api/v1/webhooks/subscribe"

payload = {
    "target_url": "https://hooks.example.com/mailr/leads",
    "event": "lead.created"
}
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({target_url: 'https://hooks.example.com/mailr/leads', event: 'lead.created'})
};

fetch('https://app.getmailr.com/api/v1/webhooks/subscribe', 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://app.getmailr.com/api/v1/webhooks/subscribe",
  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([
    'target_url' => 'https://hooks.example.com/mailr/leads',
    'event' => 'lead.created'
  ]),
  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://app.getmailr.com/api/v1/webhooks/subscribe"

	payload := strings.NewReader("{\n  \"target_url\": \"https://hooks.example.com/mailr/leads\",\n  \"event\": \"lead.created\"\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://app.getmailr.com/api/v1/webhooks/subscribe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target_url\": \"https://hooks.example.com/mailr/leads\",\n  \"event\": \"lead.created\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.getmailr.com/api/v1/webhooks/subscribe")

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  \"target_url\": \"https://hooks.example.com/mailr/leads\",\n  \"event\": \"lead.created\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "b7c8d9e0-0000-0000-0000-000000000010",
  "signing_secret": "9f8e7d6c5b4a39281706f5e4d3c2b1a09f8e7d6c5b4a39281706f5e4d3c2b1a0"
}

Authorizations

Authorization

string

header

required

Organization-scoped Mailr API key. Header: Authorization: Bearer ak_….

Body

application/json

target_url

string<uri>

required

Public https URL to deliver to. SSRF-guarded.

event

enum<string>

default:lead.created

Available options:

lead.created

Response

Subscribed (or already subscribed). Note this is 200, not 201, on both create and idempotent re-subscribe.

string<uuid>

required

signing_secret

string | null

required

Hex secret for HMAC verification. Present only when the subscription was just created (or via /api/v1/webhooks/rotate) — an idempotent re-subscribe returns null, as does a pre-signing subscription (delivered unsigned).

⌘I

Subscribe an endpoint to receive captured leads

curl --request POST \
  --url https://app.getmailr.com/api/v1/webhooks/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_url": "https://hooks.example.com/mailr/leads",
  "event": "lead.created"
}
'

import requests

url = "https://app.getmailr.com/api/v1/webhooks/subscribe"

payload = {
    "target_url": "https://hooks.example.com/mailr/leads",
    "event": "lead.created"
}
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({target_url: 'https://hooks.example.com/mailr/leads', event: 'lead.created'})
};

fetch('https://app.getmailr.com/api/v1/webhooks/subscribe', 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://app.getmailr.com/api/v1/webhooks/subscribe",
  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([
    'target_url' => 'https://hooks.example.com/mailr/leads',
    'event' => 'lead.created'
  ]),
  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://app.getmailr.com/api/v1/webhooks/subscribe"

	payload := strings.NewReader("{\n  \"target_url\": \"https://hooks.example.com/mailr/leads\",\n  \"event\": \"lead.created\"\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://app.getmailr.com/api/v1/webhooks/subscribe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target_url\": \"https://hooks.example.com/mailr/leads\",\n  \"event\": \"lead.created\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.getmailr.com/api/v1/webhooks/subscribe")

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  \"target_url\": \"https://hooks.example.com/mailr/leads\",\n  \"event\": \"lead.created\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "b7c8d9e0-0000-0000-0000-000000000010",
  "signing_secret": "9f8e7d6c5b4a39281706f5e4d3c2b1a09f8e7d6c5b4a39281706f5e4d3c2b1a0"
}

Developer API

Endpoints

Subscribe an endpoint to receive captured leads

Authorizations

Body

Response