diff --git a/cache/event-types-and-payloads.html b/cache/event-types-and-payloads.html index 882ee2638..fde55ca8f 100644 --- a/cache/event-types-and-payloads.html +++ b/cache/event-types-and-payloads.html @@ -401,6 +401,7 @@

  • RepositoryImportEvent
  • RepositoryVulnerabilityAlertEvent
  • SecurityAdvisoryEvent
    • +
  • SponsorshipEvent
  • StarEvent
  • StatusEvent
  • TeamEvent
    • @@ -9148,6 +9149,216 @@

    +

    +SponsorshipEvent

    + +

    Triggered anytime a sponsorship listing is created, cancelled, edited, or has a tier_changed, pending_cancellation, or pending_tier_change. For more information, see "About GitHub Sponsors" in the GitHub Help documentation.

    + +

    This event is not available in the Events REST API. You can only create a sponsorship webhook on GitHub. For more information, see "Configuring webhooks for events in your sponsored account" in the GitHub Help documentation.

    + + + + + + + + + + + + + + + + +
    KeyTypeDescription
    actionstringThe action that was performed. This can be one of created, cancelled, edited, tier_changed, pending_cancellation, or pending_tier_change.
    + +

    Deliveries for pending_cancellation and pending_tier_change will include effective_date. Deliveries for tier_changed and pending_tier_change will include changes[tier][from]. For more information, see the pending tier change payload.

    + +

    Deliveries for edited includechanges[privacy_level][from] in the payload with details about the change when someone edits a sponsorship to change the privacy.

    + +

    +Webhook event name

    + +

    sponsorship

    + +

    +Webhook payload example when someone creates a sponsorship

    + +
    {
+    "action": "created",
+    "sponsorship": {
+        "node_id": "MDExOlNwb25zb3JzaGlwMQ==",
+        "created_at": "2019-12-20T19:24:46+00:00",
+        "maintainer": {
+            "login": "octocat",
+            "id": 5,
+            "node_id": "MDQ6VXNlcjU=",
+            "avatar_url": "https://avatars2.githubusercontent.com/u/5?",
+            "gravatar_id": "",
+            "url": "https://api.github.com/users/octocat",
+            "html_url": "https://github.com/octocat",
+            "followers_url": "https://api.github.com/users/octocat/followers",
+            "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+            "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+            "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+            "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+            "organizations_url": "https://api.github.com/users/octocat/orgs",
+            "repos_url": "https://api.github.com/users/octocat/repos",
+            "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+            "received_events_url": "https://api.github.com/users/octocat/received_events",
+            "type": "User",
+            "site_admin": false
+        },
+        "sponsor": {
+            "login": "monalisa",
+            "id": 2,
+            "node_id": "MDQ6VXNlcjI=",
+            "avatar_url": "https://avatars2.githubusercontent.com/u/2?",
+            "gravatar_id": "",
+            "url": "https://api.github.com/users/monalisa",
+            "html_url": "https://github.com/monalisa",
+            "followers_url": "https://api.github.com/users/monalisa/followers",
+            "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+            "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+            "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+            "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+            "organizations_url": "https://api.github.com/users/monalisa/orgs",
+            "repos_url": "https://api.github.com/users/monalisa/repos",
+            "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+            "received_events_url": "https://api.github.com/users/monalisa/received_events",
+            "type": "User",
+            "site_admin": true
+        },
+        "privacy_level": "public",
+        "tier": {
+            "node_id": "MDEyOlNwb25zb3JzVGllcjE=",
+            "created_at": "2019-12-20T19:17:05Z",
+            "description": "foo",
+            "monthly_price_in_cents": 500,
+            "monthly_price_in_dollars": 5,
+            "name": "$5 a month"
+        }
+    },
+    "sender": {
+        "login": "monalisa",
+        "id": 2,
+        "node_id": "MDQ6VXNlcjI=",
+        "avatar_url": "https://avatars2.githubusercontent.com/u/2?",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/monalisa",
+        "html_url": "https://github.com/monalisa",
+        "followers_url": "https://api.github.com/users/monalisa/followers",
+        "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+        "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+        "organizations_url": "https://api.github.com/users/monalisa/orgs",
+        "repos_url": "https://api.github.com/users/monalisa/repos",
+        "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/monalisa/received_events",
+        "type": "User",
+        "site_admin": true
+    }
+}
+
    + + +

    +Webhook payload example when someone downgrades a sponsorship

    + +
    {
+    "action": "pending_tier_change",
+    "sponsorship": {
+        "node_id": "MDExOlNwb25zb3JzaGlwMQ==",
+        "created_at": "2019-12-20T19:24:46+00:00",
+        "maintainer": {
+            "login": "octocat",
+            "id": 5,
+            "node_id": "MDQ6VXNlcjU=",
+            "avatar_url": "https://avatars2.githubusercontent.com/u/5?",
+            "gravatar_id": "",
+            "url": "https://api.github.com/users/octocat",
+            "html_url": "https://github.com/octocat",
+            "followers_url": "https://api.github.com/users/octocat/followers",
+            "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+            "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+            "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+            "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+            "organizations_url": "https://api.github.com/users/octocat/orgs",
+            "repos_url": "https://api.github.com/users/octocat/repos",
+            "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+            "received_events_url": "https://api.github.com/users/octocat/received_events",
+            "type": "User",
+            "site_admin": false
+        },
+        "sponsor": {
+            "login": "monalisa",
+            "id": 2,
+            "node_id": "MDQ6VXNlcjI=",
+            "avatar_url": "https://avatars2.githubusercontent.com/u/2?",
+            "gravatar_id": "",
+            "url": "https://api.github.com/users/monalisa",
+            "html_url": "https://github.com/monalisa",
+            "followers_url": "https://api.github.com/users/monalisa/followers",
+            "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+            "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+            "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+            "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+            "organizations_url": "https://api.github.com/users/monalisa/orgs",
+            "repos_url": "https://api.github.com/users/monalisa/repos",
+            "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+            "received_events_url": "https://api.github.com/users/monalisa/received_events",
+            "type": "User",
+            "site_admin": true
+        },
+        "privacy_level": "private",
+        "tier": {
+            "node_id": "MDEyOlNwb25zb3JzVGllcjE=",
+            "created_at": "2019-12-20T19:17:05Z",
+            "description": "foo",
+            "monthly_price_in_cents": 500,
+            "monthly_price_in_dollars": 5,
+            "name": "$5 a month"
+        }
+    },
+    "changes": {
+        "tier": {
+            "from": {
+                "node_id": "MDEyOlNwb25zb3JzVGllcjI=",
+                "created_at": "2019-12-20T19:26:26Z",
+                "description": "bar",
+                "monthly_price_in_cents": 1000,
+                "monthly_price_in_dollars": 10,
+                "name": "$10 a month"
+            }
+        }
+    },
+    "effective_date": "2019-12-30T00:00:00+00:00",
+    "sender": {
+        "login": "monalisa",
+        "id": 2,
+        "node_id": "MDQ6VXNlcjI=",
+        "avatar_url": "https://avatars2.githubusercontent.com/u/2?",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/monalisa",
+        "html_url": "https://github.com/monalisa",
+        "followers_url": "https://api.github.com/users/monalisa/followers",
+        "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+        "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+        "organizations_url": "https://api.github.com/users/monalisa/orgs",
+        "repos_url": "https://api.github.com/users/monalisa/repos",
+        "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/monalisa/received_events",
+        "type": "User",
+        "site_admin": true
+    }
+}
+
    + +

    StarEvent

    @@ -9179,7 +9390,7 @@

    -Webhook event name

    +Webhook event name

    star

    @@ -9355,7 +9566,7 @@

    -Webhook event name

    +Webhook event name

    status

    @@ -9664,7 +9875,7 @@

    -Webhook event name

    +Webhook event name

    team

    @@ -9856,7 +10067,7 @@

    -Webhook event name

    +Webhook event name

    team_add

    @@ -10039,7 +10250,7 @@

    -Webhook event name

    +Webhook event name

    watch

    diff --git a/index.json b/index.json index 5cf5d5af0..1e078ba64 100644 --- a/index.json +++ b/index.json @@ -6897,6 +6897,177 @@ } ] }, + { + "name": "sponsorship", + "actions": [], + "examples": [ + { + "action": "created", + "sponsorship": { + "node_id": "MDExOlNwb25zb3JzaGlwMQ==", + "created_at": "2019-12-20T19:24:46+00:00", + "maintainer": { + "login": "octocat", + "id": 5, + "node_id": "MDQ6VXNlcjU=", + "avatar_url": "https://avatars2.githubusercontent.com/u/5?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "sponsor": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://avatars2.githubusercontent.com/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "privacy_level": "public", + "tier": { + "node_id": "MDEyOlNwb25zb3JzVGllcjE=", + "created_at": "2019-12-20T19:17:05Z", + "description": "foo", + "monthly_price_in_cents": 500, + "monthly_price_in_dollars": 5, + "name": "$5 a month" + } + }, + "sender": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://avatars2.githubusercontent.com/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + } + }, + { + "action": "pending_tier_change", + "sponsorship": { + "node_id": "MDExOlNwb25zb3JzaGlwMQ==", + "created_at": "2019-12-20T19:24:46+00:00", + "maintainer": { + "login": "octocat", + "id": 5, + "node_id": "MDQ6VXNlcjU=", + "avatar_url": "https://avatars2.githubusercontent.com/u/5?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "sponsor": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://avatars2.githubusercontent.com/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "privacy_level": "private", + "tier": { + "node_id": "MDEyOlNwb25zb3JzVGllcjE=", + "created_at": "2019-12-20T19:17:05Z", + "description": "foo", + "monthly_price_in_cents": 500, + "monthly_price_in_dollars": 5, + "name": "$5 a month" + } + }, + "changes": { + "tier": { + "from": { + "node_id": "MDEyOlNwb25zb3JzVGllcjI=", + "created_at": "2019-12-20T19:26:26Z", + "description": "bar", + "monthly_price_in_cents": 1000, + "monthly_price_in_dollars": 10, + "name": "$10 a month" + } + } + }, + "effective_date": "2019-12-30T00:00:00+00:00", + "sender": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://avatars2.githubusercontent.com/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + } + } + ] + }, { "name": "star", "actions": [