You must be 18+ to visit this website
The content on this website is AGE RESTRICTED
Please confirm you are at least 18 years old of age. Otherwise leave the website.
Log inWebhooks Integration
How it works
Webhooks are automated messages sent from applications in response to specific events.
Once your star profile is approved, we can enable webhooks upon request.
- You can specify your webhook endpoint in your Profile Settings
- Once set up, you will start receiving POST requests as described in the section below.
Event Ordering
We do not guarantee that webhook events will always arrive in the correct order, though most events will likely be delivered sequentially. Network delays, failures, and retries may occasionally disrupt the order of delivery.
To ensure accurate processing, you can:
- Query the GraphQL API to retrieve the current state of a subscription or payment for the most up-to-date information.
- Use timestamps to sort events in the correct order.
Retries
If a webhook event cannot be delivered to your service, we will automatically retry sending it using an exponential backoff strategy. The retry intervals are as follows:
- 5 minutes
- 25 minutes
- 125 minutes (~2 hours)
- 625 minutes (~10.5 hours)
It is your responsibility to handle these retried events correctly. Each request includes an attempt attribute. If attempt is greater than 1, it means the initial HTTP request failed, and the same event is being resent.
Security
EVENT TYPES (see below, payload key is "event"):
- email_shared
- email_unshared
- new_subscription
- recurring_pledge_decreased
- recurring_pledge_increased
- shipping_address_shared
- shipping_address_unshared
- subscription_billing_failed
- subscription_cancelled
- subscription_restored
Subscription Events
EVENT TYPES (see below, payload key is "event"):
- email_shared
- email_unshared
- new_subscription
- recurring_pledge_decreased
- recurring_pledge_increased
- shipping_address_shared
- shipping_address_unshared
- subscription_billing_failed
- subscription_cancelled
- subscription_restored
PAYLOAD
{
"payload": {
"subscription": {
"id": 10059451,
"tier_id": 129388, # Unique identifier of the tier (same across all subscribers in the current tier)
"cost": 10000, # ALWAYS IN CENTS (IN THIS CASE == $100.00)
"last_payment_amount": 10000, # CAN BE NULL OR NOT EQUAL TO SUBSCRIPTION PRICE IN CASE IF THE LAST PAYMENT IS UNDER REVIEW OR TIER HAS BEEN DOWNGRADED!
"last_payment_settlement_amount": 10000, # CAN BE NULL OR NOT EQUAL TO SUBSCRIPTION PRICE IN CASE IF THE LAST PAYMENT IS UNDER REVIEW OR TIER HAS BEEN DOWNGRADED!
"subscriber_id": 91953,
"created_at_timestamp": 1573138322,
"charged_at_timestamp": 1573138322,
"extended_at_timestamp": 1573138322, # THE DATE FROM WHICH WE COUNT NEXT RECURRING BILLING DATE (USUALLY EQUAL TO CHARGED_AT)
"profile_id": 1, # YOUR STAR PROFILE ID
"billing_failed": false,
"billing_failed_at_timestamp": null,
"cancelled": false,
"cancelled_at_timestamp": null,
"paused": false,
"paused_at_timestamp": null,
"restored_at": null,
"trusted": false # PASSED TRUSTED PERIOD (SEE PROFILE SETTINGS)
},
"subscriber": {
"email": "[email protected]",
"nickname": "John Doe",
"id": 91953
}
},
"event": "new_subscription", # CAB BE: "email_shared", "email_unshared", "shipping_address_shared", "shipping_address_unshared", "recurring_pledge_increased", "recurring_pledge_decreased", "subscription_billing_failed", "new_subscription", "subscription_cancelled"
"project": "subscribestar",
"timestamp": 1573138322
}Payment Events
Please test it out using http://webhook.site/ before going fully live.
Before you launch
Please test it out using http://webhook.site/ before going fully live.
