Webhook

Forward subscription events to your own web server.

When you set a Webhook, Adapty sends a POST verification event in a format

{
adapty_check: {{check_string}}
}

Your server must respond with 200 or 201 code and return 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 Event section to understand which events Adapty sends.

Event is wrapped into the following structure

{
"profile_id": "772204ce-ebf6-4ed9-82b0-d8688ab62b01",
"customer_user_id": "iwitaly@adapty.io",
"event_type": "non_subscription_purchase",
"event_datetime": "2020-02-18T18:40:22.000000+0000",
"event_properties": <event specific properties>
"event_api_version": 1
}

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. Learn more how to pass it using SDK. Null if you didn't set it

event_type

str

Lower cased event name

event_api_version

int

Current Adapty API version. Current value is 1

event_properties

json str

JSON string of event properties

Event names mapping

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

Changing event name

name can be any string except a blank.