Типы событий и поля вебхуков

Adapty отправляет вебхуки в ответ на события подписки. В этом разделе описаны типы событий и данные, содержащиеся в каждом вебхуке.

Типы событий вебхука

Вы можете отправлять в вебхук все типы событий или выбрать только нужные. Ознакомьтесь с нашими потоками событий, чтобы понять, какие данные ожидать и как выстроить вокруг них бизнес-логику. Ненужные типы событий можно отключить при настройке интеграции с вебхуком. Там же можно заменить стандартные идентификаторы событий Adapty на собственные, если это необходимо.

Структура события вебхука

Adapty будет отправлять только те события, которые вы выбрали в разделе Events names на странице Integrations -> Webhooks. События webhook сериализуются в JSON. Тело POST-запроса к вашему серверу будет содержать сериализованное событие, обёрнутое в структуру ниже. Все события следуют одной и той же структуре, но их поля различаются в зависимости от типа события, стора и вашей конкретной конфигурации. Атрибуты пользователя — это пользовательские атрибуты, которые вы настроили, поэтому они содержат именно те данные, которые вы задали. Поля данных атрибуции одинаковы для всех типов событий, однако список атрибуций зависит от того, какие источники атрибуции вы используете в мобильном приложении. Ниже приведён пример события:

{
  "profile_id": "00000000-0000-0000-0000-000000000000",
  "customer_user_id": "UserIdInYourSystem",
  "idfv": "00000000-0000-0000-0000-000000000000",
  "idfa": "00000000-0000-0000-0000-000000000000",
  "advertising_id": "00000000-0000-0000-0000-000000000000",
  "profile_install_datetime": "2000-01-31T00:00:00.000000+0000",
  "user_agent": "ExampleUserAgent/1.0 (Device; OS Version) Browser/Engine",
  "email": "[email protected]",
  "event_type": "subscription_started",
  "event_datetime": "2000-01-31T00:00:00.000000+0000",
  "event_properties": {
    "store": "play_store",
    "currency": "USD",
    "price_usd": 4.99,
    "profile_id": "00000000-0000-0000-0000-000000000000",
    "cohort_name": "All Users",
    "environment": "Production",
    "price_local": 4.99,
    "base_plan_id": "b1",
    "developer_id": "onboarding_placement",
    "ab_test_name": "onboarding_ab_test",
    "ab_test_revision": 1,
    "paywall_name": "UsedPaywall",
    "proceeds_usd": 4.2315,
    "variation_id": "00000000-0000-0000-0000-000000000000",
    "purchase_date": "2024-11-15T10:45:36.181000+0000",
    "store_country": "AR",
    "event_datetime": "2000-01-31T00:00:00.000000+0000",
    "proceeds_local": 4.2415,
    "tax_amount_usd": 0,
    "transaction_id": "0000000000000000",
    "net_revenue_usd": 4.2415,
    "profile_country": "AR",
    "paywall_revision": "1",
    "profile_event_id": "00000000-0000-0000-0000-000000000000",
    "tax_amount_local": 0,
    "net_revenue_local": 4.2415,
    "vendor_product_id": "onemonth_no_trial",
    "profile_ip_address": "10.10.1.1",
    "consecutive_payments": 1,
    "rate_after_first_year": false,
    "original_purchase_date": "2000-01-31T00:00:00.000000+0000",
    "original_transaction_id": "0000000000000000",
    "subscription_expires_at": "2000-01-31T00:00:00.000000+0000",
    "profile_has_access_level": true,
    "profile_total_revenue_usd": 4.99,
    "promotional_offer_id": null,
    "store_offer_category": null,
    "store_offer_discount_type": null
  },
  "event_api_version": 1,
  "profiles_sharing_access_level": [{"profile_id": "00000000-0000-0000-0000-000000000000", "customer_user_id": "UserIdInYourSystem"}],
   "attributions": {
    "appsflyer": {
      "ad_set": "Keywords 1.12",
      "status": "non_organic",
      "channel": "Google Ads",
      "ad_group": null,
      "campaign": "Social media influencers - Rest of the world",
      "creative": null,
      "created_at": "2000-01-31T00:00:00.000000+0000"
    }
  },
  "user_attributes": {"Favourite_color": "Violet", "Pet_name": "Fluffy"},
  "integration_ids": {"firebase_app_instance_id": "val1", "branch_id": "val2", "one_signal_player_id": "val3"},
  "play_store_purchase_token": {
    "product_id": "product_123",
    "purchase_token": "token_abc_123",
    "is_subscription": true
  }
}

Поля события

Параметры события одинаковы для всех типов событий.

Атрибуции

Чтобы отправлять данные атрибуции, включите опцию Send Attribution на странице Integrations -> Webhooks. Если вы включили отправку данных атрибуции и настроили интеграции атрибуции, данные ниже будут отправляться вместе с событием для каждого источника. Одни и те же данные атрибуции отправляются для всех типов событий.

{
  "attributions": {
    "appsflyer": {
      "ad_set": "sample_ad_set_123",
      "status": "non_organic",
      "channel": "sample_channel",
      "ad_group": "sample_ad_group_456",
      "campaign": "sample_ios_campaign",
      "creative": "sample_creative_789",
      "created_at": "2000-01-31T00:00:00.000000+0000",
      "network_user_id": "0000000000000-0000000"
    }
  }
}

Идентификаторы интеграций

Следующие идентификаторы интеграций используются в событиях:

• adjust_device_id
• airbridge_device_id
• amplitude_device_id
• amplitude_user_id
• appmetrica_device_id
• appmetrica_profile_id
• appsflyer_id
• branch_id
• facebook_anonymous_id
• firebase_app_instance_id
• mixpanel_user_id
• pushwoosh_hwid
• one_signal_player_id
• one_signal_subscription_id
• tenjin_analytics_installation_id
• posthog_distinct_user_id

Токен покупки Play Store

Это поле содержит все данные, необходимые для повторной валидации покупки при необходимости. Оно отправляется только если включена опция Send Play Store purchase token в настройках интеграции с Webhook.

Свойства событий

Свойства событий могут различаться в зависимости от типа события и даже между событиями одного типа. Например, событие из App Store не будет содержать Android-специфичные свойства, такие как base_plan_id. У события Access Level Updated есть особые свойства, поэтому мы выделили для него отдельный раздел. Аналогично, мы вынесли Дополнительные свойства событий налогов и выручки в отдельный раздел, поскольку они характерны лишь для отдельных типов событий.

Для большинства типов событий

Свойства событий для большинства типов событий одинаковы (за исключением события Access Level Updated, которое описано в отдельном разделе). Ниже приведена подробная таблица свойств с указанием того, к каким именно событиям они относятся.

Дополнительные свойства событий для налогов и выручки

Перечисленные ниже свойства событий, связанные с налогами и выручкой, — это дополнительные поля, которые применяются только к определённым типам событий. Это означает, что указанные типы событий включают свойства событий для большинства типов событий, а также дополнительные поля, перечисленные ниже.

Типы событий, для которых применяются свойства налогов и выручки:

• subscription_renewed
• subscription_initial_purchase (также называется subscription_started — то же самое событие)
• subscription_refunded
• non_subscription_purchase | Поле | Тип | Описание | | :-------------------- | :---- | :----------------------------------------------------------- | | net_revenue_local | Float | Чистый доход (после вычета комиссии Apple/Google и налогов) в местной валюте. | | net_revenue_usd | Float | Чистый доход (после вычета комиссии Apple/Google и налогов) в USD. | | proceeds_local | Float | Цена продукта после вычета комиссии Apple/Google в местной валюте. | | proceeds_usd | Float | Цена продукта после вычета комиссии Apple/Google. | | tax_amount_local | Float | Сумма удержанного налога в местной валюте. | | tax_amount_usd | Float | Сумма удержанного налога в USD. |

Пример полезной нагрузки non_subscription_purchase

non_subscription_purchase следует той же структуре, что и события подписки, но отражает разовую или расходуемую покупку. Поля, специфичные для подписок, не применяются: cancellation_reason, will_renew, is_in_grace_period, is_refund, is_lifetime и trial_duration отсутствуют. Поле subscription_expires_at присутствует, но равно null. Поля налогов и выручки (net_revenue_*, proceeds_*, tax_amount_*) включены.

{
  "profile_id": "00000000-0000-0000-0000-000000000000",
  "customer_user_id": "UserIdInYourSystem",
  "event_type": "non_subscription_purchase",
  "event_datetime": "2000-01-31T00:00:00.000000+0000",
  "event_properties": {
    "store": "app_store",
    "currency": "USD",
    "price_usd": 4.99,
    "price_local": 4.99,
    "proceeds_usd": 4.2415,
    "proceeds_local": 4.2415,
    "net_revenue_usd": 4.2415,
    "net_revenue_local": 4.2415,
    "tax_amount_usd": 0,
    "tax_amount_local": 0,
    "profile_id": "00000000-0000-0000-0000-000000000000",
    "environment": "Production",
    "vendor_product_id": "100coins",
    "transaction_id": "0000000000000000",
    "original_transaction_id": "0000000000000000",
    "purchase_date": "2024-11-15T10:45:36.181000+0000",
    "original_purchase_date": "2024-11-15T10:45:36.181000+0000",
    "subscription_expires_at": null,
    "store_country": "US",
    "profile_country": "US",
    "profile_ip_address": "10.10.1.1",
    "profile_has_access_level": false,
    "profile_total_revenue_usd": 4.99,
    "consecutive_payments": 1,
    "rate_after_first_year": false,
    "profile_event_id": "00000000-0000-0000-0000-000000000000"
  },
  "event_api_version": 1
}

Для события Access Level Updated

Событие Access Level Updated — это специфическое webhook-событие, которое генерируется только при активной интеграции Webhook и включённом типе этого события. Если оно включено, оно отправляется на настроенный Webhook и отображается в Event Feed. Если не включено, событие не создаётся.

Если вы включили общий доступ к уровням доступа, событие access level updated будет отправлено для всех профилей, имеющих доступ к данному уровню доступа.