Adapty envía webhooks en respuesta a eventos de suscripción. Esta sección define los tipos de eventos y los datos que contiene cada webhook.

Tipos de eventos de webhook

Puedes enviar todos los tipos de eventos a tu webhook o elegir solo algunos. Consulta nuestros Flujos de eventos para saber qué tipo de datos entrantes puedes esperar y cómo estructurar tu lógica de negocio en torno a ellos. Puedes desactivar los tipos de eventos que no necesites al configurar tu integración con Webhook. También puedes sustituir los IDs de eventos predeterminados de Adapty por los tuyos propios si es necesario.

Nombre del evento	Descripción
subscription_started	Se activa cuando un usuario activa una suscripción de pago sin período de prueba, es decir, se le cobra de inmediato.
subscription_renewed	Ocurre cuando se renueva una suscripción y se cobra al usuario. Este evento comienza a partir de la segunda facturación, tanto en suscripciones con prueba como sin ella.
subscription_renewal_cancelled	El usuario ha desactivado la renovación automática de la suscripción. El usuario conserva el acceso a las funciones premium hasta el final del período de suscripción pagado.
subscription_renewal_reactivated	Se activa cuando un usuario reactiva la renovación automática de la suscripción.
subscription_expired	Se activa cuando una suscripción finaliza por completo tras ser cancelada. Por ejemplo, si un usuario cancela una suscripción el 12 de diciembre pero esta permanece activa hasta el 31 de diciembre, el evento se registra el 31 de diciembre cuando la suscripción expira.
subscription_paused	Ocurre cuando un usuario activa la pausa de suscripción (solo Android).
subscription_deferred	Se activa cuando una compra de suscripción se aplaza, lo que permite a los usuarios retrasar el pago manteniendo el acceso a las funciones premium. Esta función está disponible a través de la Google Play Developer API y puede usarse para pruebas gratuitas o para ayudar a usuarios con dificultades económicas.
non_subscription_purchase	Cualquier compra que no sea una suscripción, como el acceso de por vida o productos consumibles como monedas del juego.
trial_started	Se activa cuando un usuario activa una suscripción de prueba.
trial_converted	Ocurre cuando finaliza una prueba y se cobra al usuario (primera compra). Por ejemplo, si un usuario tiene una prueba hasta el 14 de enero pero se le cobra el 7 de enero, este evento se registra el 7 de enero.
trial_renewal_cancelled	El usuario desactivó la renovación automática de la suscripción durante el período de prueba. El usuario conserva el acceso a las funciones premium hasta que finalice la prueba, pero no se le cobrará ni comenzará una suscripción.
trial_renewal_reactivated	Ocurre cuando un usuario reactiva la renovación automática de la suscripción durante el período de prueba.
trial_expired	Se activa cuando finaliza una prueba sin convertirse en suscripción.
entered_grace_period	Ocurre cuando falla un intento de pago y el usuario entra en un período de gracia (si está habilitado). El usuario conserva el acceso premium durante este tiempo.
billing_issue_detected	Se activa cuando ocurre un problema de facturación durante un intento de cobro (p. ej., saldo insuficiente en la tarjeta).
subscription_refunded	Se activa cuando se reembolsa una suscripción (p. ej., por parte del soporte de Apple).
non_subscription_purchase_refunded	Se activa cuando se reembolsa una compra que no es una suscripción.
access_level_updated	Ocurre cuando se actualiza el nivel de acceso de un usuario.

Estructura de eventos del webhook

Adapty te enviará únicamente los eventos que hayas seleccionado en la sección Events names de la página Integrations -> Webhooks. Los eventos de webhook se serializan en JSON. El cuerpo de la solicitud POST a tu servidor contendrá el evento serializado con la siguiente estructura. Todos los eventos siguen la misma estructura, pero sus campos varían según el tipo de evento, el store y tu configuración específica. Los atributos de usuario son los atributos de usuario personalizados que hayas configurado, por lo que contienen lo que hayas definido. Los campos de datos de atribución son iguales para todos los tipos de eventos; sin embargo, la lista de atribuciones dependerá de las fuentes de atribución que uses en tu app móvil. A continuación encontrarás un ejemplo de evento:

{
  "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
  }
}

Campos del evento

Los parámetros del evento son los mismos para todos los tipos de evento.

Campo	Tipo	Descripción
advertising_id	UUID	ID de publicidad (solo Android).
attributions	JSON	Datos de atribución. Se incluye si Send Attribution está habilitado en los ajustes del Webhook.
customer_user_id	String	ID de usuario de tu app (UUID, email u otro ID) si lo configuras en el código de tu app al identificar usuarios. Si no identificas usuarios en el código de la app o este usuario concreto es anónimo (no ha iniciado sesión), este campo es null.
email	String	Email del usuario si lo configuras mediante el método updateProfile en el SDK de Adapty o al crear/actualizar perfiles a través de la API del servidor. Si no pasas el valor email al SDK o al método de la API, este campo es null.
event_api_version	Integer	Versión de la API de Adapty (actual: 1).
event_datetime	ISO 8601	Marca de tiempo del evento en formato ISO 8601 (p. ej., 2020-07-10T15:00:00.000000+0000).
event_properties	JSON	Propiedades del evento.
event_type	String	Nombre del evento en formato Adapty. Consulta los tipos de eventos del Webhook para ver la lista completa.
idfa	UUID	ID de publicidad (solo Apple). IDFA en el perfil en el Adapty Dashboard. Puede ser null si no está disponible por restricciones de seguimiento, modo para niños o ajustes de privacidad.
idfv	UUID	Identificador para proveedores (IDFV), único por desarrollador. IDFV en el perfil en el Adapty Dashboard.
integration_ids	JSON	IDs de integración del usuario si los configuras mediante el método setIntegrationIdentifier en el SDK de Adapty o al crear/actualizar perfiles a través de la API del servidor. null si no están disponibles o las integraciones están deshabilitadas.
play_store_purchase_token	JSON	Token de compra de Play Store, incluido si Send Play Store purchase token está habilitado en los ajustes del Webhook.
profile_id	UUID	ID de perfil generado automáticamente por Adapty para cada perfil. Un mismo ID de Apple/Google puede asociarse a diferentes IDs de perfil si no identificas usuarios o permites compras antes del inicio de sesión. Más información sobre cómo funciona Adapty con perfiles padre/heredero.
profile_install_datetime	ISO 8601	Marca de tiempo de instalación en formato ISO 8601 (p. ej., 2020-07-10T15:00:00.000000+0000).
profiles_sharing_access_level	JSON	Lista de usuarios que comparten el nivel de acceso excluyendo el perfil del usuario actual. Si el uso compartido de niveles de acceso está habilitado para tu app, esta lista incluye otros perfiles que se han usado con el mismo ID de Apple/Google. Formato: profile_id: (UUID) ID de Adapty customer_user_id: (String) Customer User ID si se ha proporcionado
user_agent	String	User-agent del navegador del dispositivo.
user_attributes	JSON	Datos personalizados que puedes configurar para enriquecer los perfiles de usuario con información específica de la app. Se usan habitualmente para registrar preferencias del usuario (p. ej., tema, idioma) o indicadores de comportamiento (onboarding completado, uso de funciones). Con formato de pares clave-valor donde las claves son cadenas y los valores pueden ser cadenas o números (p. ej., {"Favourite_color": "Violet", "Pet_name": "Fluffy"}). Puedes configurar atributos personalizados manualmente en el Adapty Dashboard para perfiles individuales, de forma programática mediante el método updateProfile en el SDK de Adapty, o a través de la API del servidor al crear/actualizar perfiles. Se incluye si Send User Attributes está habilitado en los ajustes del Webhook. Aunque los valores de los atributos personalizados en el código de la app móvil pueden definirse como floats o strings, los atributos recibidos a través de la API del servidor o una importación histórica pueden llegar en distintos formatos. En ese caso, los valores booleanos y enteros se convertirán a float.

Atribuciones

Para enviar los datos de atribución, activa la opción Send Attribution en la página Integrations -> Webhooks. Si has activado el envío de datos de atribución y has configurado las integraciones de atribución, los datos que se muestran a continuación se enviarán con el evento para cada fuente. Los mismos datos de atribución se envían a todos los tipos de eventos.

{
  "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"
    }
  }
}

Nombre del campo	Tipo de campo	Descripción
ad_set	String	Conjunto de anuncios de atribución.
status	String	Puede ser organic, non_organic, o unknown.
channel	String	Nombre del canal de marketing.
ad_group	String	Grupo de anuncios de atribución.
campaign	String	Nombre de la campaña de marketing.
creative	String	Palabra clave creativa de atribución.
created_at	ISO 8601 date	Fecha y hora de creación del registro de atribución.
network_user_id	String	ID asignado al usuario por la fuente de atribución.

IDs de integración

Los siguientes IDs de integración se utilizan actualmente en los eventos:

• 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

Token de compra de Play Store

Este campo incluye todos los datos necesarios para revalidar una compra, si fuera necesario. Solo se envía si la opción Send Play Store purchase token está habilitada en la configuración de la integración de Webhook.

Campo	Tipo	Descripción
product_id	String	El identificador único del producto (SKU) comprado en Play Store.
purchase_token	String	Token generado por Google Play para identificar de forma única esta transacción de compra.
is_subscription	Boolean	Indica si el producto comprado es una suscripción (true) o una compra única (false).

Propiedades del evento

Las propiedades de los eventos pueden variar según el tipo de evento e incluso entre eventos del mismo tipo. Por ejemplo, un evento que proviene de App Store no incluirá propiedades específicas de Android como base_plan_id. El evento Nivel de acceso actualizado tiene propiedades específicas, por lo que le hemos dedicado una sección aparte. Del mismo modo, hemos separado las Propiedades adicionales de eventos de impuestos e ingresos, ya que son exclusivas de ciertos tipos de eventos.

Para la mayoría de los tipos de eventos

Las propiedades de los eventos son consistentes en la mayoría de los tipos de eventos (excepto el evento Access Level Updated, que se describe en su propia sección). A continuación encontrarás una tabla completa con las propiedades y si pertenecen a eventos específicos.

Campo	Tipo	Descripción
ab_test_name	String	Nombre de la prueba A/B de Adapty donde se originó la transacción.
ab_test_revision	Integer	Revisión de la prueba A/B donde se originó la transacción.
base_plan_id	String	ID del plan base en Google Play Store o ID de precio en Stripe.
cancellation_reason	String	Posibles motivos de cancelación: voluntarily_cancelled, billing_error, price_increase, product_was_not_available, refund, cancelled_by_developer, new_subscription_replace, upgraded, unknown, adapty_revoked. Presente en los siguientes tipos de evento: subscription_cancelled, subscription_refunded y trial_cancelled.
cohort_name	String	Nombre de la audiencia que determinó qué paywall se mostró al usuario.
consecutive_payments	Integer	Número de períodos que un usuario lleva suscrito sin interrupciones. Incluye el período actual.
currency	String	Moneda local.
developer_id	String	ID del placement donde se originó la transacción.
environment	String	Los valores posibles son Sandbox o Production.
event_datetime	Fecha ISO 8601	Fecha y hora del evento. Igual que en el nivel raíz del evento.
original_purchase_date	Fecha ISO 8601	En suscripciones recurrentes, la compra original es la primera transacción de la cadena; su ID, llamado ID de transacción original, vincula la cadena de renovaciones. Las transacciones posteriores son extensiones de ella. La fecha de compra original es la fecha y hora de esa primera transacción.
original_transaction_id	String	En suscripciones recurrentes, es el ID de transacción original que vincula la cadena de renovaciones. La transacción original es la primera de la cadena; las siguientes son extensiones de ella. Si no hay extensiones, original_transaction_id coincide con store_transaction_id.
paywall_name	String	Nombre del paywall donde se originó la transacción.
paywall_revision	String	Revisión del paywall donde se originó la transacción. El valor predeterminado es 1.
price_local	Float	Precio del producto antes de la comisión de Apple/Google en moneda local.
price_usd	Float	Precio del producto antes de la comisión de Apple/Google en USD.
profile_country	String	Determinado por Adapty a partir de la IP del perfil.
profile_event_id	UUID	ID de evento único que puede usarse para deduplicación.
profile_has_access_level	Boolean	Valor booleano que indica si el perfil tiene un nivel de acceso activo.
profile_id	UUID	ID de perfil generado por Adapty. Igual que en el nivel raíz del evento.
profile_ip_address	String	IP del perfil (puede ser IPv4 o IPv6; se prefiere IPv4 cuando está disponible). null si Collect users’ IP addresses está desactivado en los ajustes de la app.
profile_total_revenue_usd	Float	Ingresos totales del perfil con los reembolsos descontados.
promotional_offer_id	String	ID de Adapty de la oferta promocional utilizada. Este ID lo defines tú al crear una oferta en el dashboard.
purchase_date	Fecha ISO 8601	Fecha y hora de la compra del producto.
rate_after_first_year	Boolean	Booleano que indica que la suscripción cumple los requisitos para una comisión reducida (normalmente el 15%) tras un año de renovación continua. Las tasas de comisión varían según la elegibilidad del programa y el país. Consulta Comisión del store e impuestos para más detalles.
store	String	Store donde se realizó la compra. Valores estándar: app_store, play_store, stripe, paddle. Si configuras transacciones de store personalizadas mediante la API del servidor, se usa el valor del parámetro store.
store_country	String	País enviado por el app store.
store_offer_category	String	Categoría de oferta aplicada. Los valores posibles son introductory, promotional, winback.
store_offer_discount_type	String	Tipo de oferta aplicada. Los valores posibles son free_trial, pay_as_you_go y pay_up_front.
subscription_expires_at	Fecha ISO 8601	Fecha de vencimiento de la suscripción. Normalmente en el futuro.
transaction_id	String	Identificador único de una transacción.
trial_duration	String	Duración del período de prueba en días. Se envía con el formato ” days”, por ejemplo, “7 days”. Presente solo en los tipos de evento relacionados con pruebas: trial_started, trial_converted, trial_cancelled.
variation_id	UUID	ID único del paywall donde se realizó la compra.
vendor_product_id	String	ID del producto en Apple App Store, Google Play Store o Stripe.

Propiedades adicionales de impuestos e ingresos en eventos

Las propiedades de evento relacionadas con impuestos e ingresos que se muestran a continuación son campos adicionales que solo aplican a ciertos tipos de eventos. Esto significa que los tipos de eventos listados incluyen las Propiedades de evento para la mayoría de los tipos de eventos, junto con los campos extra que se detallan a continuación.

Tipos de eventos que tienen las propiedades de impuestos e ingresos:

• subscription_renewed
• subscription_initial_purchase
• subscription_refunded
• non_subscription_purchase | Campo | Tipo | Descripción | | :-------------------- | :---- | :----------------------------------------------------------- | | net_revenue_local | Float | Ingresos netos (ingresos tras la comisión de Apple/Google e impuestos) en moneda local. | | net_revenue_usd | Float | Ingresos netos (ingresos tras la comisión de Apple/Google e impuestos) en USD. | | proceeds_local | Float | Precio del producto tras la comisión de Apple/Google en moneda local. | | proceeds_usd | Float | Precio del producto tras la comisión de Apple/Google. | | tax_amount_local | Float | Importe de impuestos deducido en moneda local. | | tax_amount_usd | Float | Importe de impuestos deducido en USD. |

Para el evento Access Level Updated

El evento Access Level Updated es un evento de webhook específico que se genera únicamente cuando la integración de Webhook está activa y este tipo de evento está habilitado. Si está habilitado, se envía al Webhook configurado y aparece en el Event Feed. Si no está habilitado, el evento no se creará.

Si has habilitado el uso compartido de niveles de acceso, el evento access level updated se enviará para todos los perfiles que compartan el nivel de acceso.

Propiedad	Tipo	Descripción
ab_test_name	String	Nombre de la prueba A/B donde se originó la transacción.
access_level_id	String	El ID del nivel de acceso.
activated_at	ISO 8601 date	Fecha y hora de la última activación del acceso.
active_introductory_offer_type	String	Tipo de oferta introductoria aplicada. Los valores posibles son free_trial, pay_as_you_go y pay_up_front.
active_promotional_offer_id	String	ID de la oferta promocional indicada en la sección Product del Adapty Dashboard.
active_promotional_offer_type	String	Tipo de oferta promocional aplicada. Los valores posibles son free_trial, pay_as_you_go y pay_up_front.
base_plan_id	String	ID del plan base en Google Play Store o ID de precio en Stripe.
billing_issue_detected_at	ISO 8601 date	Fecha y hora del problema de facturación.
cancellation_reason	String	Motivos posibles de cancelación: voluntarily_cancelled, billing_error, price_increase, product_was_not_available, refund, cancelled_by_developer, new_subscription_replace, upgraded, unknown, adapty_revoked.
cohort_name	String	Nombre de la audiencia a la que pertenece el perfil.
currency	String	Moneda local (por defecto USD).
developer_id	String	El ID del placement donde se originó la transacción.
environment	String	Los valores posibles son Sandbox o Production.
event_datetime	ISO 8601 date	La fecha y hora del evento.
expires_at	ISO 8601 date	Fecha y hora en que expirará el acceso.
is_active	Boolean	Booleano que indica si el nivel de acceso está activo.
is_in_grace_period	Boolean	Booleano que indica si el perfil está en el período de gracia.
is_lifetime	Boolean	Booleano que indica si el nivel de acceso es de por vida.
is_refund	Boolean	Booleano que indica si la transacción es un reembolso.
original_purchase_date	ISO 8601 date	En suscripciones recurrentes, la compra original es la primera transacción de la cadena, cuyo ID (llamado original transaction ID) vincula la cadena de renovaciones; las transacciones posteriores son extensiones de ella. La fecha de compra original es la fecha y hora de esta primera transacción.
original_transaction_id	String	En suscripciones recurrentes, es el ID de transacción original que vincula la cadena de renovaciones. La transacción original es la primera de la cadena; las posteriores son extensiones de ella. Si no hay extensiones, original_transaction_id coincide con store_transaction_id. El identificador de transacción de la compra original.
paywall_name	String	Nombre del paywall donde se originó la transacción.
paywall_revision	String	Revisión del paywall donde se originó la transacción. El valor por defecto es 1.
profile_country	String	Determinado por Adapty a partir de la IP del perfil.
profile_event_id	UUID	ID de evento único que puede usarse para deduplicación.
profile_has_access_level	Boolean	Booleano que indica si el perfil tiene un nivel de acceso activo.
profile_id	UUID	ID interno de perfil de usuario de Adapty.
profile_ip_address	String	Dirección IP del perfil del usuario.
profile_total_revenue_usd	Float	Ingresos totales del perfil, incluidos los reembolsos.
purchase_date	ISO 8601 date	La fecha y hora de compra del producto.
renewed_at	ISO 8601 date	Fecha y hora en que se renovará el acceso.
starts_at	ISO 8601 date	Fecha y hora en que comienza el nivel de acceso.
store	String	Store donde se compró el producto. Valores estándar: app_store, play_store, stripe, paddle. Si configuras transacciones de store personalizadas mediante la API del servidor, se usa el valor del parámetro store.
store_country	String	País enviado a Adapty por el store.
subscription_expires_at	ISO 8601 date	Fecha de expiración de la suscripción.
transaction_id	String	Identificador único de una transacción.
trial_duration	String	Duración del período de prueba en días (p. ej., “7 days”).
variation_id	UUID	Identificador de una variante, usado para atribuir compras a este paywall.
vendor_product_id	String	ID del producto en el store (Apple/Google/Stripe).
will_renew	Boolean	Indica si el nivel de acceso de pago se renovará.