Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

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

Body

application/json

Canonical enriched lead (same shape at the poll endpoint and the outbound webhook). Flattened custom_<field_id> keys are added dynamically.

mailr_lead_id
string
required

Equal to id. Echo it back in record.properties.mailr_lead_id to trigger the loop guard.

id
string<uuid>
test
boolean

Present and true only on the setup sample lead.

name
string | null
first_name
string
last_name
string
email
string | null
phone
string | null

Normalized E.164 when parseable.

address
string | null

Street line.

street
string | null
city
string | null
state
string

Two-letter state; empty string when unknown.

postal_code
string | null
country
string
Example:

"United States"

full_address
string | null

Street, city, state and postal joined into one line.

latitude
number | null
longitude
number | null
message
string | null
campaign_id
string | null
campaign_name
string | null
source
string
Example:

"Mailr"

custom_fields
object[]
created_at
string<date-time>

Response

2XX

Mailr does not inspect your response status — a delivery is considered attempted once the request completes. Non-2xx responses are ignored; timeouts and blocked hosts are recorded in Mailr's server logs only (not in your webhook log) and are not retried. Poll GET /api/v1/integrations/leads to reconcile anything your endpoint dropped.