Body
application/json
Webhook payload
Response
200
Return a 200 OK to indiate that the payload has been successfully received.
Any other response will cause the webhook to retry up to 5 times, over a period of several hours (TODO)
Alpha Release: The Admin API and its documentation are currently in alpha and subject to change. Features, endpoints, and functionality may be modified or updated without notice.
{
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event_timestamp": "<string>",
"payload": {
"member_id": 123,
"created_at": "2025-11-07T23:17:22+00:00",
"updated_at": "2025-11-07T23:17:22+00:00",
"email": "ada.lovelace@example.com",
"first_name": "<string>",
"last_name": "<string>",
"time_zone": "<string>",
"location": "<string>",
"referral_count": 123,
"avatar": "<string>",
"categories": [
{
"id": 123,
"title": "<string>"
}
],
"permalink": "<string>",
"ambassador_level": "<string>",
"plan": {
"id": 123,
"name": "<string>",
"amount": 123,
"currency": "<string>",
"interval": "<string>",
"type": "<string>",
"has_free_trial": true
},
"subscription": {
"id": "1234",
"current_period_start": "2025-11-07T23:17:22+00:00",
"current_period_end": "2025-11-07T23:17:22+00:00",
"payment_platform": "<string>",
"canceled_at": "2025-11-07T23:17:22+00:00",
"trial_length": 123,
"trial_start": "2025-11-07T23:17:22+00:00",
"trial_end": "2025-11-07T23:17:22+00:00",
"purchased_at": "2025-11-07T23:17:22+00:00"
}
}
}Triggered when a member is removed from a plan
{
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event_timestamp": "<string>",
"payload": {
"member_id": 123,
"created_at": "2025-11-07T23:17:22+00:00",
"updated_at": "2025-11-07T23:17:22+00:00",
"email": "ada.lovelace@example.com",
"first_name": "<string>",
"last_name": "<string>",
"time_zone": "<string>",
"location": "<string>",
"referral_count": 123,
"avatar": "<string>",
"categories": [
{
"id": 123,
"title": "<string>"
}
],
"permalink": "<string>",
"ambassador_level": "<string>",
"plan": {
"id": 123,
"name": "<string>",
"amount": 123,
"currency": "<string>",
"interval": "<string>",
"type": "<string>",
"has_free_trial": true
},
"subscription": {
"id": "1234",
"current_period_start": "2025-11-07T23:17:22+00:00",
"current_period_end": "2025-11-07T23:17:22+00:00",
"payment_platform": "<string>",
"canceled_at": "2025-11-07T23:17:22+00:00",
"trial_length": 123,
"trial_start": "2025-11-07T23:17:22+00:00",
"trial_end": "2025-11-07T23:17:22+00:00",
"purchased_at": "2025-11-07T23:17:22+00:00"
}
}
}Webhook payload
Return a 200 OK to indiate that the payload has been successfully received.
Any other response will cause the webhook to retry up to 5 times, over a period of several hours (TODO)