Skip to content
adscapi

Yelp CAPI Payload Preview

The server-side request adscapi builds when you track() a purchase and Yelp is configured. Secrets and hashed values show as placeholders.

Request

POST
Endpoint
https://api.yelp.com/v3/conversion/event
Headers
Authorization: Bearer {YELP_TOKEN}
Content-Type: application/json
Body (purchase example)
{
  "event": {
    "event_id": "order_1001",
    "event_time": 1739452800,
    "event_name": "purchase",
    "action_source": "website",
    "user_data": {
      "em": [
        "<sha256(normalized-email)>"
      ],
      "ph": [
        "<sha256(11-digit-phone)>"
      ],
      "client_ip_address": "203.0.113.10",
      "ylpcid": "ylpcid-example-123"
    },
    "custom_data": {
      "value": 49.99,
      "currency": "USD",
      "order_id": "order_1001"
    }
  }
}

Verified against the library dispatcher (src/dispatchers/yelp.ts). See the Yelp setup guide for where to get each secret.

Required secrets

YELP_TOKEN

Yelp activates when every secret is present. One missing key and the platform no-ops — the rest still receive the event.

Event-name mapping

Canonical eventYelp receives
page_viewview_content
leadlead
signup_startsignup_start (custom event passthrough)
signupsignup
checkout_createdcheckout
purchasepurchase
reply_generatedreply_generated (custom event passthrough)
upgrade_clickedupgrade_clicked (custom event passthrough)

Good to know

  • The dispatcher computes event_name itself: purchase and lead pass through, every other canonical name gets a custom_ prefix (the registry map above is not consulted).
  • Phone is hashed as digits only with a leading country code (11 digits, a NANP 1 is assumed), not E.164.
  • em, ph, and client_ip_address send only with adUserData consent; ylpcid only with adPersonalization consent, never hashed.
  • Success is HTTP 202.

Frequently Asked Questions

Related Tools

Discover more free tools to fix your tracking

Event Payload Playground

Pick a canonical conversion event, fill the fields, and see the exact JSON payload adscapi builds — before you write a line of code.

Try it now

PII Hash Previewer

Type a raw email or phone number and see the normalized value plus its SHA-256 hash — the exact rules adscapi applies per platform. Nothing leaves the browser.

Try it now

Platform Coverage Explorer

Search all 26 ad platforms adscapi dispatches to — support level, required secrets, and setup docs, always in sync with the library registry.

Try it now

Ready to track Yelp conversions server-side?

adscapi is free and open source. Set your platform tokens, call track() once, and every configured Conversions API receives the event — hashed the way each platform expects.

Get startednpm install adscapi