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.
Discord & Slack support: Basic
Raw format payload
{
"type": "benefit.created",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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.
Discord & Slack support: Basic
Raw format payload
{
"type": "benefit.updated",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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.
Discord & Slack support: Full
Raw format payload
{
"type": "donation.created",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"amount": 0,
"currency": "string",
"message": "string",
"donor": {
"id": "00000000-0000-0000-0000-000000000000",
"platform": "github",
"name": "string",
"avatar_url": "string",
"is_personal": false
},
"email": "string",
"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-09-06T00:00:00.000Z",
"issue_modified_at": "2024-09-06T00:00:00.000Z",
"issue_created_at": "2024-09-06T00:00:00.000Z",
"needs_confirmation_solved": false,
"confirmed_solved_at": "2024-09-06T00:00:00.000Z",
"funding": {
"funding_goal": {
"currency": "string",
"amount": 0
},
"pledges_sum": {
"currency": "string",
"amount": 0
}
},
"repository": {
"id": "string",
"platform": "github",
"is_private": false,
"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",
"organization_id": "00000000-0000-0000-0000-000000000000"
}
},
"upfront_split_to_contributors": 0,
"pledge_badge_currently_embedded": false,
"badge_custom_content": "string"
}
}
}
order.created
Sent when a new order is created.
Discord & Slack support: Full
Raw format payload
{
"type": "order.created",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"amount": 0,
"tax_amount": 0,
"currency": "string",
"user_id": "00000000-0000-0000-0000-000000000000",
"product_id": "00000000-0000-0000-0000-000000000000",
"product_price_id": "00000000-0000-0000-0000-000000000000",
"subscription_id": "00000000-0000-0000-0000-000000000000",
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "string",
"public_name": "string",
"github_username": "string",
"avatar_url": "string"
},
"product": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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
},
"product_price": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"price_amount": 0,
"price_currency": "string",
"is_archived": false,
"type": "recurring",
"recurring_interval": "month"
},
"subscription": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"status": "incomplete",
"current_period_start": "2024-09-06T00:00:00.000Z",
"current_period_end": "2024-09-06T00:00:00.000Z",
"cancel_at_period_end": false,
"started_at": "2024-09-06T00:00:00.000Z",
"ended_at": "2024-09-06T00:00:00.000Z",
"user_id": "00000000-0000-0000-0000-000000000000",
"product_id": "00000000-0000-0000-0000-000000000000",
"price_id": "00000000-0000-0000-0000-000000000000"
}
}
}
organization.updated
Sent when a organization is updated.
Discord & Slack support: Basic
Raw format payload
{
"type": "organization.updated",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"avatar_url": "string",
"bio": "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,
"donations_enabled": false,
"profile_settings": {
"description": "string",
"featured_projects": [
"00000000-0000-0000-0000-000000000000"
],
"featured_organizations": [
"00000000-0000-0000-0000-000000000000"
],
"links": [
"string"
],
"subscribe": {
"promote": false,
"show_count": false,
"count_free": false
}
},
"feature_settings": {
"articles_enabled": false,
"subscriptions_enabled": false,
"issue_funding_enabled": false
}
}
}
pledge.created
Sent when a new pledge is created. Note that this does mean that the pledge has been paid yet.
Discord & Slack support: Full
Raw format payload
{
"type": "pledge.created",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"amount": 0,
"currency": "string",
"state": "initiated",
"type": "pay_upfront",
"refunded_at": "2024-09-06T00:00:00.000Z",
"scheduled_payout_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"issue_modified_at": "2024-09-06T00:00:00.000Z",
"issue_created_at": "2024-09-06T00:00:00.000Z",
"needs_confirmation_solved": false,
"confirmed_solved_at": "2024-09-06T00:00:00.000Z",
"funding": {
"funding_goal": {
"currency": "string",
"amount": 0
},
"pledges_sum": {
"currency": "string",
"amount": 0
}
},
"repository": {
"id": "string",
"platform": "github",
"is_private": false,
"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",
"organization_id": "00000000-0000-0000-0000-000000000000"
}
},
"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.
Discord & Slack support: Basic
Raw format payload
{
"type": "pledge.updated",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"amount": 0,
"currency": "string",
"state": "initiated",
"type": "pay_upfront",
"refunded_at": "2024-09-06T00:00:00.000Z",
"scheduled_payout_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"issue_modified_at": "2024-09-06T00:00:00.000Z",
"issue_created_at": "2024-09-06T00:00:00.000Z",
"needs_confirmation_solved": false,
"confirmed_solved_at": "2024-09-06T00:00:00.000Z",
"funding": {
"funding_goal": {
"currency": "string",
"amount": 0
},
"pledges_sum": {
"currency": "string",
"amount": 0
}
},
"repository": {
"id": "string",
"platform": "github",
"is_private": false,
"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",
"organization_id": "00000000-0000-0000-0000-000000000000"
}
},
"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.
Discord & Slack support: Basic
Raw format payload
{
"type": "product.created",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"version": "string",
"service": "product_media",
"is_uploaded": false,
"created_at": "2024-09-06T00:00:00.000Z"
}
]
}
}
product.updated
Sent when a product is updated.
Discord & Slack support: Basic
Raw format payload
{
"type": "product.updated",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"version": "string",
"service": "product_media",
"is_uploaded": false,
"created_at": "2024-09-06T00:00:00.000Z"
}
]
}
}
subscription.created
Sent when a new subscription is created.
Discord & Slack support: Full
Raw format payload
{
"type": "subscription.created",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"status": "incomplete",
"current_period_start": "2024-09-06T00:00:00.000Z",
"current_period_end": "2024-09-06T00:00:00.000Z",
"cancel_at_period_end": false,
"started_at": "2024-09-06T00:00:00.000Z",
"ended_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"version": "string",
"service": "product_media",
"is_uploaded": false,
"created_at": "2024-09-06T00:00:00.000Z"
}
]
},
"price": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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.
Discord & Slack support: On cancellation
Raw format payload
{
"type": "subscription.updated",
"data": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"status": "incomplete",
"current_period_start": "2024-09-06T00:00:00.000Z",
"current_period_end": "2024-09-06T00:00:00.000Z",
"cancel_at_period_end": false,
"started_at": "2024-09-06T00:00:00.000Z",
"ended_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00: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-09-06T00:00:00.000Z",
"version": "string",
"service": "product_media",
"is_uploaded": false,
"created_at": "2024-09-06T00:00:00.000Z"
}
]
},
"price": {
"created_at": "2024-09-06T00:00:00.000Z",
"modified_at": "2024-09-06T00:00:00.000Z",
"id": "00000000-0000-0000-0000-000000000000",
"price_amount": 0,
"price_currency": "string",
"is_archived": false,
"type": "recurring",
"recurring_interval": "month"
}
}
}