Webhook

Forward subscription events to your own web server.

Setup the Endpoint URL

To setup the integration with Webhook go to Integrations > Webhook in your Adapty dashboard, turn on a toggle from off to on, and fill out fields.

Endpoint URL is used by Adapty to send HTTP POST requests to this URL when events occur. We’ll send an isMount event to your endpoint upon saving, and it must respond with a 200 HTTP code.
Authorization header value is by your server to verify the validity of the requests made from Adapty. This field is optional but is recommended to be set up for better security.

Request Format

📘
Be sure your endpoint has Content-Type: application/json header.

Whenever an event occurs, Adapty triggers a POST request to the endpoint URL.

When you activate a Webhook, Adapty sends a POST verification event in the following format:

{
    adapty_check: {{check_string}}
}

Your server must respond with 200 or 201 code and return the event containing:

{
    adapty_check_response: {{check_string}}
}

with the same check_string

After that Adapty sends POST events about your users.

Event structure

Refer to the Events section to understand which events Adapty sends.

Each event is wrapped into the following structure

{
  "profile_id": "772204ce-ebf6-4ed9-82b0-d8688ab62b01",
  "customer_user_id": "123",
  "idfv": "00000000-0000-0000-0000-000000000000",
  "idfa": "00000000-0000-0000-0000-000000000000",
  "advertising_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "non_subscription_purchase",
  "event_datetime": "2020-02-18T18:40:22.000000+0000",
  "event_properties": <event specific properties>,
  "event_api_version": 1,
  "attributions": {"attribution_source1": <attribution_data>, "attribution_source2": <attribution_data>, ...},
  "user_attributes": {"attribute_name1": "attribute_value1", "attribute_name2": "attribute_value2", ...}
  "integration_ids": {"firebase_app_instance_id": "val1", "branch_id": "val2", "one_signal_player_id": "val3", ... }
}

Where

Property	Type	Description
profile_id	str	Adapty user ID.
customer_user_id	str	Developer user ID. For example, it can be your user UUID, email, or any other ID. Null if you didn't set it.
idfv	str	IDFV value.
idfa	str	IDFA value.
advertising_id	str	Advertising ID value.
event_type	str	Lower cased event name.
event_api_version	int	Current Adapty API version. The current value is 2.
event_properties	json	JSON of event properties.
attributions	json	JSON of attribution data.
user_attributes	json	JSON of custom user attributes.
integration_ids	json	JSON of users integration identifiers. If a user doesn`t have any identifier or integrations are disabled, then a null is sent.

Webhook integration enables to control of sending attribution and user attributes. You can find Send Attribution and Send User Attributes in the Webhook integration page of your Adapty Dashboard. Enabling the Send Attribution option will send information about the source of app installs from data providers. Enabling the Send User Attributes option will send custom user attributes set up from the Adapty SDK, such as user preferences and app usage data.

Event names mapping

You can change the mapping from default Adapty event names to your own

Changing event name

The name can be any string except a blank.