Webhook events
You'll find below the list of events we may send to your webhook endpoint, along with their payload structure.
Benefit Created
Sent when a new benefit is created.{
"type": "benefit.created",
"data": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"type": "articles",
"description": "string",
"selectable": false,
"deletable": false,
"organization_id": "00000000-0000-0000-0000-000000000000",
"properties": {
"paid_articles": false
}
}
}Benefit Updated
Sent when a benefit is updated.{
"type": "benefit.updated",
"data": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"type": "articles",
"description": "string",
"selectable": false,
"deletable": false,
"organization_id": "00000000-0000-0000-0000-000000000000",
"properties": {
"paid_articles": false
}
}
}Donation Created
Sent when a new donation is created.{
"type": "donation.created",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"amount": {
"currency": "string",
"amount": 0
},
"message": "string",
"donor": {
"id": "00000000-0000-0000-0000-000000000000",
"platform": "github",
"name": "string",
"avatar_url": "string",
"is_personal": false
},
"email": "string",
"created_at": "2024-07-16T00:00:00.000Z",
"issue": {
"id": "string",
"platform": "github",
"number": 0,
"title": "string",
"body": "string",
"comments": 0,
"labels": [
{
"name": "string",
"color": "string"
}
],
"author": {
"id": 0,
"login": "string",
"html_url": "string",
"avatar_url": "string"
},
"assignees": [
{
"id": 0,
"login": "string",
"html_url": "string",
"avatar_url": "string"
}
],
"reactions": {
"total_count": 0,
"plus_one": 0,
"minus_one": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 0
},
"state": "OPEN",
"issue_closed_at": "2024-07-16T00:00:00.000Z",
"issue_modified_at": "2024-07-16T00:00:00.000Z",
"issue_created_at": "2024-07-16T00:00:00.000Z",
"needs_confirmation_solved": false,
"confirmed_solved_at": "2024-07-16T00:00:00.000Z",
"funding": {
"funding_goal": {
"currency": "string",
"amount": 0
},
"pledges_sum": {
"currency": "string",
"amount": 0
}
},
"repository": {
"id": "string",
"platform": "github",
"visibility": "public",
"name": "string",
"description": "string",
"stars": 0,
"license": "string",
"homepage": "string",
"profile_settings": {
"description": "string",
"cover_image_url": "string",
"featured_organizations": [
"00000000-0000-0000-0000-000000000000"
],
"highlighted_subscription_tiers": [
"00000000-0000-0000-0000-000000000000"
],
"links": [
"string"
]
},
"organization": {
"id": "string",
"platform": "github",
"name": "string",
"avatar_url": "string",
"is_personal": false,
"bio": "string",
"pretty_name": "string",
"company": "string",
"blog": "string",
"location": "string",
"email": "string",
"twitter_username": "string",
"pledge_minimum_amount": 0,
"pledge_badge_show_amount": false,
"default_upfront_split_to_contributors": 0,
"account_id": "00000000-0000-0000-0000-000000000000",
"has_app_installed": false,
"public_page_enabled": false,
"donations_enabled": false,
"public_donation_timestamps": false,
"profile_settings": {
"description": "string",
"featured_projects": [
"00000000-0000-0000-0000-000000000000"
],
"featured_organizations": [
"00000000-0000-0000-0000-000000000000"
],
"links": [
"string"
]
},
"feature_settings": {
"articles_enabled": false,
"subscriptions_enabled": false,
"issue_funding_enabled": false
},
"billing_email": "string",
"total_monthly_spending_limit": 0,
"per_user_monthly_spending_limit": 0,
"is_teams_enabled": false
}
},
"upfront_split_to_contributors": 0,
"pledge_badge_currently_embedded": false,
"badge_custom_content": "string"
}
}
}Organization Updated
Sent when a organization is updated.{
"type": "organization.updated",
"data": {
"id": "string",
"platform": "github",
"name": "string",
"avatar_url": "string",
"is_personal": false,
"bio": "string",
"pretty_name": "string",
"company": "string",
"blog": "string",
"location": "string",
"email": "string",
"twitter_username": "string",
"pledge_minimum_amount": 0,
"pledge_badge_show_amount": false,
"default_upfront_split_to_contributors": 0,
"account_id": "00000000-0000-0000-0000-000000000000",
"has_app_installed": false,
"public_page_enabled": false,
"donations_enabled": false,
"public_donation_timestamps": false,
"profile_settings": {
"description": "string",
"featured_projects": [
"00000000-0000-0000-0000-000000000000"
],
"featured_organizations": [
"00000000-0000-0000-0000-000000000000"
],
"links": [
"string"
]
},
"feature_settings": {
"articles_enabled": false,
"subscriptions_enabled": false,
"issue_funding_enabled": false
},
"billing_email": "string",
"total_monthly_spending_limit": 0,
"per_user_monthly_spending_limit": 0,
"is_teams_enabled": false
}
}Pledge Created
Sent when a new pledge is created. Note that this does mean that the pledge has been paid yet.{
"type": "pledge.created",
"data": {
"id": "string",
"created_at": "2024-07-16T00:00:00.000Z",
"amount": {
"currency": "string",
"amount": 0
},
"state": "initiated",
"type": "pay_upfront",
"refunded_at": "2024-07-16T00:00:00.000Z",
"scheduled_payout_at": "2024-07-16T00:00:00.000Z",
"issue": {
"id": "string",
"platform": "github",
"number": 0,
"title": "string",
"body": "string",
"comments": 0,
"labels": [
{
"name": "string",
"color": "string"
}
],
"author": {
"id": 0,
"login": "string",
"html_url": "string",
"avatar_url": "string"
},
"assignees": [
{
"id": 0,
"login": "string",
"html_url": "string",
"avatar_url": "string"
}
],
"reactions": {
"total_count": 0,
"plus_one": 0,
"minus_one": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 0
},
"state": "OPEN",
"issue_closed_at": "2024-07-16T00:00:00.000Z",
"issue_modified_at": "2024-07-16T00:00:00.000Z",
"issue_created_at": "2024-07-16T00:00:00.000Z",
"needs_confirmation_solved": false,
"confirmed_solved_at": "2024-07-16T00:00:00.000Z",
"funding": {
"funding_goal": {
"currency": "string",
"amount": 0
},
"pledges_sum": {
"currency": "string",
"amount": 0
}
},
"repository": {
"id": "string",
"platform": "github",
"visibility": "public",
"name": "string",
"description": "string",
"stars": 0,
"license": "string",
"homepage": "string",
"profile_settings": {
"description": "string",
"cover_image_url": "string",
"featured_organizations": [
"00000000-0000-0000-0000-000000000000"
],
"highlighted_subscription_tiers": [
"00000000-0000-0000-0000-000000000000"
],
"links": [
"string"
]
},
"organization": {
"id": "string",
"platform": "github",
"name": "string",
"avatar_url": "string",
"is_personal": false,
"bio": "string",
"pretty_name": "string",
"company": "string",
"blog": "string",
"location": "string",
"email": "string",
"twitter_username": "string",
"pledge_minimum_amount": 0,
"pledge_badge_show_amount": false,
"default_upfront_split_to_contributors": 0,
"account_id": "00000000-0000-0000-0000-000000000000",
"has_app_installed": false,
"public_page_enabled": false,
"donations_enabled": false,
"public_donation_timestamps": false,
"profile_settings": {
"description": "string",
"featured_projects": [
"00000000-0000-0000-0000-000000000000"
],
"featured_organizations": [
"00000000-0000-0000-0000-000000000000"
],
"links": [
"string"
]
},
"feature_settings": {
"articles_enabled": false,
"subscriptions_enabled": false,
"issue_funding_enabled": false
},
"billing_email": "string",
"total_monthly_spending_limit": 0,
"per_user_monthly_spending_limit": 0,
"is_teams_enabled": false
}
},
"upfront_split_to_contributors": 0,
"pledge_badge_currently_embedded": false,
"badge_custom_content": "string"
},
"pledger": {
"name": "string",
"github_username": "string",
"avatar_url": "string"
},
"hosted_invoice_url": "string",
"authed_can_admin_sender": false,
"authed_can_admin_received": false,
"created_by": {
"name": "string",
"github_username": "string",
"avatar_url": "string"
}
}
}Pledge Updated
Sent when a pledge is updated.{
"type": "pledge.updated",
"data": {
"id": "string",
"created_at": "2024-07-16T00:00:00.000Z",
"amount": {
"currency": "string",
"amount": 0
},
"state": "initiated",
"type": "pay_upfront",
"refunded_at": "2024-07-16T00:00:00.000Z",
"scheduled_payout_at": "2024-07-16T00:00:00.000Z",
"issue": {
"id": "string",
"platform": "github",
"number": 0,
"title": "string",
"body": "string",
"comments": 0,
"labels": [
{
"name": "string",
"color": "string"
}
],
"author": {
"id": 0,
"login": "string",
"html_url": "string",
"avatar_url": "string"
},
"assignees": [
{
"id": 0,
"login": "string",
"html_url": "string",
"avatar_url": "string"
}
],
"reactions": {
"total_count": 0,
"plus_one": 0,
"minus_one": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 0
},
"state": "OPEN",
"issue_closed_at": "2024-07-16T00:00:00.000Z",
"issue_modified_at": "2024-07-16T00:00:00.000Z",
"issue_created_at": "2024-07-16T00:00:00.000Z",
"needs_confirmation_solved": false,
"confirmed_solved_at": "2024-07-16T00:00:00.000Z",
"funding": {
"funding_goal": {
"currency": "string",
"amount": 0
},
"pledges_sum": {
"currency": "string",
"amount": 0
}
},
"repository": {
"id": "string",
"platform": "github",
"visibility": "public",
"name": "string",
"description": "string",
"stars": 0,
"license": "string",
"homepage": "string",
"profile_settings": {
"description": "string",
"cover_image_url": "string",
"featured_organizations": [
"00000000-0000-0000-0000-000000000000"
],
"highlighted_subscription_tiers": [
"00000000-0000-0000-0000-000000000000"
],
"links": [
"string"
]
},
"organization": {
"id": "string",
"platform": "github",
"name": "string",
"avatar_url": "string",
"is_personal": false,
"bio": "string",
"pretty_name": "string",
"company": "string",
"blog": "string",
"location": "string",
"email": "string",
"twitter_username": "string",
"pledge_minimum_amount": 0,
"pledge_badge_show_amount": false,
"default_upfront_split_to_contributors": 0,
"account_id": "00000000-0000-0000-0000-000000000000",
"has_app_installed": false,
"public_page_enabled": false,
"donations_enabled": false,
"public_donation_timestamps": false,
"profile_settings": {
"description": "string",
"featured_projects": [
"00000000-0000-0000-0000-000000000000"
],
"featured_organizations": [
"00000000-0000-0000-0000-000000000000"
],
"links": [
"string"
]
},
"feature_settings": {
"articles_enabled": false,
"subscriptions_enabled": false,
"issue_funding_enabled": false
},
"billing_email": "string",
"total_monthly_spending_limit": 0,
"per_user_monthly_spending_limit": 0,
"is_teams_enabled": false
}
},
"upfront_split_to_contributors": 0,
"pledge_badge_currently_embedded": false,
"badge_custom_content": "string"
},
"pledger": {
"name": "string",
"github_username": "string",
"avatar_url": "string"
},
"hosted_invoice_url": "string",
"authed_can_admin_sender": false,
"authed_can_admin_received": false,
"created_by": {
"name": "string",
"github_username": "string",
"avatar_url": "string"
}
}
}Product Created
Sent when a new product is created.{
"type": "product.created",
"data": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"is_recurring": false,
"is_archived": false,
"organization_id": "00000000-0000-0000-0000-000000000000",
"type": "free",
"is_highlighted": false,
"prices": [
{
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"price_amount": 0,
"price_currency": "string",
"is_archived": false,
"type": "recurring",
"recurring_interval": "month"
}
],
"benefits": [
{
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"type": "custom",
"description": "string",
"selectable": false,
"deletable": false,
"organization_id": "00000000-0000-0000-0000-000000000000"
}
],
"medias": [
{
"id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2024-07-16T00:00:00.000Z",
"version": "string",
"service": "product_media",
"is_uploaded": false,
"created_at": "2024-07-16T00:00:00.000Z"
}
]
}
}Product Updated
Sent when a product is updated.{
"type": "product.updated",
"data": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"is_recurring": false,
"is_archived": false,
"organization_id": "00000000-0000-0000-0000-000000000000",
"type": "free",
"is_highlighted": false,
"prices": [
{
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"price_amount": 0,
"price_currency": "string",
"is_archived": false,
"type": "recurring",
"recurring_interval": "month"
}
],
"benefits": [
{
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"type": "custom",
"description": "string",
"selectable": false,
"deletable": false,
"organization_id": "00000000-0000-0000-0000-000000000000"
}
],
"medias": [
{
"id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2024-07-16T00:00:00.000Z",
"version": "string",
"service": "product_media",
"is_uploaded": false,
"created_at": "2024-07-16T00:00:00.000Z"
}
]
}
}Subscription Created
Sent when a new subscription is created.{
"type": "subscription.created",
"data": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"status": "incomplete",
"current_period_start": "2024-07-16T00:00:00.000Z",
"current_period_end": "2024-07-16T00:00:00.000Z",
"cancel_at_period_end": false,
"started_at": "2024-07-16T00:00:00.000Z",
"ended_at": "2024-07-16T00:00:00.000Z",
"user_id": "00000000-0000-0000-0000-000000000000",
"product_id": "00000000-0000-0000-0000-000000000000",
"price_id": "00000000-0000-0000-0000-000000000000",
"user": {
"email": "string",
"public_name": "string",
"github_username": "string",
"avatar_url": "string"
},
"product": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"is_recurring": false,
"is_archived": false,
"organization_id": "00000000-0000-0000-0000-000000000000",
"type": "free",
"is_highlighted": false,
"prices": [
{
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"price_amount": 0,
"price_currency": "string",
"is_archived": false,
"type": "recurring",
"recurring_interval": "month"
}
],
"benefits": [
{
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"type": "custom",
"description": "string",
"selectable": false,
"deletable": false,
"organization_id": "00000000-0000-0000-0000-000000000000"
}
],
"medias": [
{
"id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2024-07-16T00:00:00.000Z",
"version": "string",
"service": "product_media",
"is_uploaded": false,
"created_at": "2024-07-16T00:00:00.000Z"
}
]
},
"price": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"price_amount": 0,
"price_currency": "string",
"is_archived": false,
"type": "recurring",
"recurring_interval": "month"
}
}
}Subscription Updated
Sent when a new subscription is updated. This event fires if the subscription is cancelled, both immediately and if the subscription is cancelled at the end of the current period.{
"type": "subscription.updated",
"data": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"status": "incomplete",
"current_period_start": "2024-07-16T00:00:00.000Z",
"current_period_end": "2024-07-16T00:00:00.000Z",
"cancel_at_period_end": false,
"started_at": "2024-07-16T00:00:00.000Z",
"ended_at": "2024-07-16T00:00:00.000Z",
"user_id": "00000000-0000-0000-0000-000000000000",
"product_id": "00000000-0000-0000-0000-000000000000",
"price_id": "00000000-0000-0000-0000-000000000000",
"user": {
"email": "string",
"public_name": "string",
"github_username": "string",
"avatar_url": "string"
},
"product": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"is_recurring": false,
"is_archived": false,
"organization_id": "00000000-0000-0000-0000-000000000000",
"type": "free",
"is_highlighted": false,
"prices": [
{
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"price_amount": 0,
"price_currency": "string",
"is_archived": false,
"type": "recurring",
"recurring_interval": "month"
}
],
"benefits": [
{
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"type": "custom",
"description": "string",
"selectable": false,
"deletable": false,
"organization_id": "00000000-0000-0000-0000-000000000000"
}
],
"medias": [
{
"id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2024-07-16T00:00:00.000Z",
"version": "string",
"service": "product_media",
"is_uploaded": false,
"created_at": "2024-07-16T00:00:00.000Z"
}
]
},
"price": {
"created_at": "2024-07-16T00:00:00.000Z",
"modified_at": "2024-07-16T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"price_amount": 0,
"price_currency": "string",
"is_archived": false,
"type": "recurring",
"recurring_interval": "month"
}
}
}