Skip to main content
WEBHOOK
purchase.completed
{
  "id": "evt_00000000000000000000000000",
  "type": "<string>",
  "created_at": 123,
  "location": {
    "funnel_id": "<string>",
    "funnel_version": 123,
    "origin": "<string>",
    "query": "<string>",
    "query_params": {},
    "sandbox": true,
    "onboarding": "<string>",
    "experiment_id": "<string>",
    "experiment_title": "<string>",
    "experiment_alias": "<string>"
  },
  "profile": {
    "id": "pro_00000000000000000000000000",
    "session_id": "ses_00000000000000000000000000",
    "email": "[email protected]",
    "country": "GB",
    "ip": "00.00.000.00",
    "city": "Birmingham",
    "time_zone": "Europe/London",
    "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_5_1 like Mac OS X)",
    "locale": "🇪🇸 Spanish",
    "locale_code": "en_US"
  },
  "project_id": "00000000000000000000000000",
  "is_sandbox": false,
  "session_id": "ses_00000000000000000000000000",
  "data": {
    "id": "tra_00000000000000000000000000",
    "created_at": 1716672462,
    "profile_id": "pro_00000000000000000000000000",
    "is_sandbox": false,
    "session_id": "ses_00000000000000000000000000",
    "currency": "USD",
    "price": 1099,
    "vendor": "stripe",
    "vendor_profile_id": "cus_XXXXXXXXXXXXXX",
    "vendor_transaction_id": "in_XXXXXXXXXXXXXXXXXXXXXXXX",
    "subscription": {
      "vendor_subscription_id": "sub_XXXXXXXXXXXXXXXXXXXXXXXX",
      "starts_at": 1716672462,
      "ends_at": 1716672462
    },
    "vendor_discount_id": "dsc_XXXXXXXXXXXXXXXXXXXXXXXXXX",
    "vendor_price_id": "price_XXXXXXXXXXXXXXXXXXXXXXXX",
    "vendor_product_id": "prod_XXXXXXXXXXXXXX"
  },
  "funnel_id": "00000000000000000000000000",
  "profile_id": "pro_00000000000000000000000000"
}

Body

application/json

Fires, when user has completed a purchase or when recurrent/upsell purchase happens.

​
id
string
required
Example:

"evt_00000000000000000000000000"

​
type
string
required
Examples:

"onboarding.started"

"onboarding.completed"

"purchase.completed"

"profile.updated"

"subscription.activated"

"subscription.cancelled"

"subscription.renewed"

​
created_at
integer<int64>
required

UNIX timestamp in seconds

​
location
object
required
​
profile
object
required
​
project_id
string
required
Example:

"00000000000000000000000000"

​
is_sandbox
boolean
required
Example:

false

​
session_id
string
required
Example:

"ses_00000000000000000000000000"

​
data
object
required
​
funnel_id
string
deprecated
Example:

"00000000000000000000000000"

​
profile_id
string
deprecated
Example:

"pro_00000000000000000000000000"

Response

200

Event received successfully