Nextdoor Conversion API Reference
The Nextdoor Conversion API destination is currently in Early Access. Please contact [email protected] for more information about this integration.
Destination Info
Supports Track calls
Supports HIPAA mode
Refer to this destination as Nextdoor Conversions API in the Integrations object
Connection Modes:
Web
Mobile
Server
This is a reference document for the Nextdoor destination. For information on how to set up this integration, see the Nextdoor Conversion API Quick Start Guide.
Events
When you send an event to the Nextdoor Conversion API destination from Freshpaint, Freshpaint will create an event in the Nextdoor event manager by hitting Nextdoor's API.
Properties
$ndclid
click_id
string
Required
Nextdoor's click ID, used for attribution of clicks to conversion events.
$event_id
event_id
string
Required
Unique identifier for the event chosen by the advertiser, used for deduplication. Freshpaint will autofill this value.
$event_time
event_time_epoch
long
Required
Timestamp with ISO 8601 format for when the event occurred. Freshpaint will autofill this value if missing.
$action_source
action_source
string
Required
The medium through which the conversion was made. See Nextdoor's documentation for the list of valid values: https://developer.nextdoor.com/reference/conversions-track
The default is website if not provided.
nextdoor_event_name
event_name
string
Recommended
The Nextdoor event name to track. See the "Accepted Event Names" chart below for valid values. Note: If this property is absent, Freshpaint will attempt to use the name of the Freshpaint event. This will only work if the Freshpaint event name is one of the specific supported Nextdoor names, so we recommend sending event name separately.
event_source_url
event_source_url
string
Optional
The URL where the event occurred, must start with "http://" or "https://". Freshpaint will use the url where the event occurred on your website if not provided and coming from the Freshpaint Javascript SDK.
Accepted Event Names
Nextdoor only accepts particular strings for valid event_name values. The full list can be seen in Nextdoor's API documentation here: https://developer.nextdoor.com/reference/conversions-track
Valid event names include:
add_to_cartadd_to_wishlistinitiate_checkoutleadpage_viewpurchasesearchsign_upsubscribeview_contentcustom_conversion_# (where accepted numbers are 1 through 10, ie
custom_conversion_7)
User Data Properties
When you send user actions to Nextdoor, Nextdoor will attempt to match those actions to a particular Nextdoor user.
Nextdoor requires a number of the user parameters to be hashed. Freshpaint will automatically hash these user values when sending them to Nextdoor's API.
Nextdoor also requires a number of normalization rules. The Freshpaint integration will automatically normalize most user data fields according to Nextdoor's requirements.
A detailed description of formatting and normalization rules can be found in Nextdoor's documentation here: https://developer.nextdoor.com/reference/conversion-data-types
$ip
client_ip_address
string
Recommended
IP address of the customer's device.
$user_agent
client_user_agent
string
Recommended
The user agent of the browser where the event occurred.
email
email
string
Recommended
The email of the user.
Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
phone
phone_number
string
Recommended
The phone number of the user.
Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
first_name
first_name
string
Optional
First name of the user.
Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
last_name
last_name
string
Optional
Last name of the user. Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
date_of_birth
date_of_birth
string
Optional
The user's date of birth. YYYYMMDD format.
Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
gender
gender
string
Optional
The user's gender. Nextdoor accepts "m" or "f" only. Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
city
city
string
Optional
The user's city. Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
state
state
string
Optional
The user's 2-letter state code. Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
zip
zip
string
Optional
The user's zip or postal code. Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
country
country
string
Optional
The user's 2-letter country code. Note: Freshpaint will send the hashed value to Nextdoor. You should not hash these values when sending to Freshpaint.
Custom Data
order_value
order_value
string
Recommended
The monetary value of the conversion.
Expected by Nextdoor for purchase type events.
order_id
order_id
string
Recommended
A unique transaction identifier/id for the conversion event. Expected by Nextdoor for offline events.
delivery_category
delivery_category
string
Optional
The category for how the product was delivered. For example in_store.
product_context
product_context
object
Optional
An object of:
{
"id": (string),
"quantity": (integer),
"item_price": (integer)
}Restricted Data Usage
You can send restricted_data_usage properties to restrict how Nextdoor uses your data. See their documentation: https://developer.nextdoor.com/reference/privacy-and-restricted-data-usage.
Freshpaint simply passes on these values to Nextdoor. These fields do not change the behavior within Freshpaint in any way.
restricted_data_usage
Integer
Optional
Must be true , 1, or null. Default: null.
If set to 0 or false, the below state and country fields will be set to null.
restricted_data_usage_country
Integer
Optional
Must be 1 or null. Default: null.
restricted_data_usage_state
Integer
Optional
See Nextdoor's list of valid state codes. Not all states are supported by Nextdoor. Default: null.
Last updated
Was this helpful?