Attribution

Trigger a specific automation directly

Fire one named automation directly (the pre-v1 path the Zapier app and HubSpot workflows use). Prefer POST /api/v1/events for new integrations — it binds by event type instead of hardcoding an automation id and reports richer outcomes. The target automation is named in ?id= and must belong to the key’s org. Idempotent on deal_id (a repeat short-circuits before geocoding). Field extraction is tolerant of HubSpot/Zapier mappings, so properties.* aliases and flat fields both work.

POST

api

webhooks

trigger

Trigger a specific automation directly

curl --request POST \
  --url https://app.getmailr.com/api/v1/webhooks/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "3134 River Valley Dr, Austin, TX 78701",
  "customer_first_name": "Dana",
  "customer_last_name": "Reyes",
  "deal_id": "deal-9931"
}
'

import requests

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

payload = {
    "address": "3134 River Valley Dr, Austin, TX 78701",
    "customer_first_name": "Dana",
    "customer_last_name": "Reyes",
    "deal_id": "deal-9931"
}
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({
    address: '3134 River Valley Dr, Austin, TX 78701',
    customer_first_name: 'Dana',
    customer_last_name: 'Reyes',
    deal_id: 'deal-9931'
  })
};

fetch('https://app.getmailr.com/api/v1/webhooks/trigger', 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/trigger",
  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([
    'address' => '3134 River Valley Dr, Austin, TX 78701',
    'customer_first_name' => 'Dana',
    'customer_last_name' => 'Reyes',
    'deal_id' => 'deal-9931'
  ]),
  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/trigger"

	payload := strings.NewReader("{\n  \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n  \"customer_first_name\": \"Dana\",\n  \"customer_last_name\": \"Reyes\",\n  \"deal_id\": \"deal-9931\"\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/trigger")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n  \"customer_first_name\": \"Dana\",\n  \"customer_last_name\": \"Reyes\",\n  \"deal_id\": \"deal-9931\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n  \"customer_first_name\": \"Dana\",\n  \"customer_last_name\": \"Reyes\",\n  \"deal_id\": \"deal-9931\"\n}"

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

{
  "success": true,
  "automation": "Post-job reactivation",
  "customer_added": true,
  "queued": true,
  "queue_id": "e5f6a7b8-0000-0000-0000-000000000040",
  "idempotent": false,
  "address": "3134 River Valley Dr, Austin, TX 78701, USA"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

string

required

The automation id to trigger.

Body

application/json

Highly tolerant of CRM/Zapier field shapes. address may be given flat or as properties.address (also deal_address/install_address). Name may be customer_first_name/customer_last_name, customer_name, or CRM properties.dealname/contact_name. deal_id may be properties.hs_object_id or objectId.

address

string

required

customer_first_name

string

customer_last_name

string

customer_name

string

deal_id

string

deal_amount

deal_stage

string

deal_name

string

contact_email

string

deal_date

string

mailr_lead_id

string

Echo-loop guard. Map this from the Mailr New Lead trigger when applicable.

campaign_id

string

properties

object

Show child attributes

Response

Queued (or already queued — idempotent: true). queue_id is Mailr's internal id for the queued campaign job. attribution is present only for deal_won automations that attributed revenue.

success

boolean

automation

string

Automation name (omitted on the deal_id idempotent short-circuit).

customer_added

boolean

queued

boolean

queue_id

string

Mailr's internal id for the queued campaign job.

idempotent

boolean

True when this was a replay of an already-queued deal_id.

address

string

The geocoded/formatted address (omitted on the idempotent short-circuit).

attribution

object | null

Present only for deal_won automations that attributed revenue.

⌘I

Trigger a specific automation directly

curl --request POST \
  --url https://app.getmailr.com/api/v1/webhooks/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "3134 River Valley Dr, Austin, TX 78701",
  "customer_first_name": "Dana",
  "customer_last_name": "Reyes",
  "deal_id": "deal-9931"
}
'

import requests

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

payload = {
    "address": "3134 River Valley Dr, Austin, TX 78701",
    "customer_first_name": "Dana",
    "customer_last_name": "Reyes",
    "deal_id": "deal-9931"
}
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({
    address: '3134 River Valley Dr, Austin, TX 78701',
    customer_first_name: 'Dana',
    customer_last_name: 'Reyes',
    deal_id: 'deal-9931'
  })
};

fetch('https://app.getmailr.com/api/v1/webhooks/trigger', 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/trigger",
  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([
    'address' => '3134 River Valley Dr, Austin, TX 78701',
    'customer_first_name' => 'Dana',
    'customer_last_name' => 'Reyes',
    'deal_id' => 'deal-9931'
  ]),
  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/trigger"

	payload := strings.NewReader("{\n  \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n  \"customer_first_name\": \"Dana\",\n  \"customer_last_name\": \"Reyes\",\n  \"deal_id\": \"deal-9931\"\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/trigger")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n  \"customer_first_name\": \"Dana\",\n  \"customer_last_name\": \"Reyes\",\n  \"deal_id\": \"deal-9931\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n  \"customer_first_name\": \"Dana\",\n  \"customer_last_name\": \"Reyes\",\n  \"deal_id\": \"deal-9931\"\n}"

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

{
  "success": true,
  "automation": "Post-job reactivation",
  "customer_added": true,
  "queued": true,
  "queue_id": "e5f6a7b8-0000-0000-0000-000000000040",
  "idempotent": false,
  "address": "3134 River Valley Dr, Austin, TX 78701, USA"
}

Developer API

Endpoints

Trigger a specific automation directly

Authorizations

Query Parameters

Body

Response