Do `installation` and `installation_repository` payloads have the property `installation` 100% of the times? #516

oscard0m · 2020-10-14T05:35:17Z

What article on docs.github.com is affected?

https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads

What part(s) of the article would you like to see updated?

Additional information

docs/content/developers/webhooks-and-events/webhook-events-and-payloads.md

Lines 446 to 448 in d516858

    
           {% data reusables.webhooks.installation_properties %} 
        
           {% data reusables.webhooks.app_desc %} 
        
           {% data reusables.webhooks.sender_desc %}

and

docs/content/developers/webhooks-and-events/webhook-events-and-payloads.md

Lines 470 to 472 in 20fa34e

    
           {% data reusables.webhooks.installation_repositories_properties %} 
        
           {% data reusables.webhooks.app_desc %} 
        
           {% data reusables.webhooks.sender_desc %}

Checking the description of installation property, it denotes it could exist or not:

docs/data/reusables/webhooks/app_desc.md

Line 1 in d516858

    
           `installation` | `object` | The {% data variables.product.prodname_github_app %} installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a {% data variables.product.prodname_github_app %}.

but due to the nature of the events, it should always have installation property right?

Context:

@octokit/webhook-definition is working to improve typing of installation property in Payloads so it becomes an optional property (when necessary)

The text was updated successfully, but these errors were encountered:

welcome · 2020-10-14T05:35:19Z

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

…llation' until this issue is clarified github/docs#516

lucascosti · 2020-10-16T06:47:25Z

👋 @dominguezcelada To answer your question:

Do installation and installation_repository payloads have the property installation 100% of the times?

The installation property is used in many webhooks, and has this description:

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App.

This means that if the event for the webhook involves a GitHub App, it will contain the installation property.

Because the webhooks installation and installation_repository always relate to a GitHub App, they will contain the property 100% of the time.

Comparing it other webhooks, such as repository, the payload will only contain the installation property if the event for the webhook is configured for and sent to a GitHub App.

I hope this makes sense! 🙂

oscard0m · 2020-10-16T08:30:40Z

👋 @dominguezcelada To answer your question:

Do installation and installation_repository payloads have the property installation 100% of the times?

The installation property is used in many webhooks, and has this description:

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App.

This means that if the event for the webhook involves a GitHub App, it will contain the installation property.

Because the webhooks installation and installation_repository always relate to a GitHub App, they will contain the property 100% of the time.

Comparing it other webhooks, such as repository, the payload will only contain the installation property if the event for the webhook is configured for and sent to a GitHub App.

I hope this makes sense! 🙂

Has totally sense @lucascosti . Thanks for the clear explanation 💪🏽

I was thinking... would have sense to improve a little bit the way is expressed so, in case of webhooks like installation and installation_repository where the property appears 100% of the times to rewrite it from:

The {% data variables.product.prodname_github_app %} installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a {% data variables.product.prodname_github_app %}.

to

The {% data variables.product.prodname_github_app %} installation.

only for this kind of events.

Do you think it could have sense this improvement?

Thanks for your time!

lucascosti · 2020-10-18T23:40:47Z

to

The {% data variables.product.prodname_github_app %} installation.

only for this kind of events.

@dominguezcelada 👍 I think that makes sense. For those endpoints, we could remove the {% data reusables.webhooks.app_desc %} reusable and just add a normal table row with that simple description. Feel free to reopen this issue and submit a PR to the docs 🙂

oscard0m · 2020-10-18T23:43:09Z

to
The {% data variables.product.prodname_github_app %} installation. 
only for this kind of events.
@dominguezcelada 👍 I think that makes sense. For those endpoints, we could remove the {% data reusables.webhooks.app_desc %} reusable and just add a normal table row with that simple description. Feel free to reopen this issue and submit a PR to the docs 🙂

Cool! I will be happy to open a PR for this.

Should I create a new issue linking to this one? Seems I'm not able to re-open the issue myself.

Thanks @lucascosti

lucascosti · 2020-10-18T23:44:30Z

Seems I'm not able to re-open the issue myself.

My bad, I forgot that external contributors can't reopen 😊 . Reopened for you 🚀

Kerruba · 2020-10-30T15:33:13Z

Hello, I'm building my own GitHub App using ProBot and I've a registered app on some private repositories.
My GitHub app has been registered with webhooks to push events, though in the payload I'm receiving from GitHub I'm not receiving the installation object as part of the payload. Could be that my Application is not registered properly? I have an installation ID available, and I'm able to create an authenticated client with octokit by providing that installation ID.

Does the app required to be configured in a special way in order to receive the installation property as part of the push event payload?

lucascosti · 2020-11-03T03:26:15Z

👋 @Kerruba! This docs repository is not the best place to troubleshoot product issues not directly related to the documentation. Better places to get help would be the GitHub Support Community forums, or contacting GitHub Support. 🙂

oscard0m · 2020-12-10T00:03:10Z

@lucascosti I ended up opening a PR for this after a long time! Would it be possible to re-open this issue? I think it was closed by mistake or by its inactivity

#1948

github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 14, 2020

oscard0m added a commit to octokit/webhooks that referenced this issue Oct 14, 2020

fix(examples): installation and installation_repos always have 'insta…

81eca5d

…llation' until this issue is clarified github/docs#516

oscard0m mentioned this issue Oct 14, 2020

fix: add event examples with installation key that don't have them yet octokit/webhooks#195

Merged

janiceilene added the ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team label Oct 15, 2020

lucascosti closed this as completed Oct 16, 2020

lucascosti reopened this Oct 18, 2020

janiceilene closed this as completed Nov 3, 2020

This comment has been minimized.

Sign in to view

oscard0m mentioned this issue Dec 9, 2020

docs(webhooks-and-event-payloads): 'installation' property is always … #1948

Merged

4 tasks

lucascosti reopened this Dec 10, 2020

lucascosti closed this as completed in #1948 Dec 10, 2020

This was referenced May 28, 2021

[Snyk] Upgrade dotenv from 8.2.0 to 8.6.0 bitokenja3/docs#69

Merged

[Snyk] Upgrade dotenv from 8.2.0 to 8.6.0 bitokenja3/docs#75

Open

Anmar1988260 mentioned this issue Nov 30, 2023

[Snyk] Fix for 1 vulnerabilities Anmar1988260/docs#263

Open

montana910318 mentioned this issue Nov 30, 2023

[Snyk] Fix for 1 vulnerabilities montana910318/docs#253

Open

makombelajob mentioned this issue Nov 30, 2023

[Snyk] Fix for 1 vulnerabilities makombelajob/docs#8

Open

qmutz mentioned this issue Nov 30, 2023

[Snyk] Fix for 1 vulnerabilities inteI-cloud/docs#16

Open

oudomskn mentioned this issue Nov 30, 2023

[Snyk] Fix for 1 vulnerabilities oudomskn/docs#250

Open

Visva92 mentioned this issue Nov 30, 2023

[Snyk] Fix for 1 vulnerabilities Visva92/docs#149

Open

ryan-ally mentioned this issue Nov 30, 2023

[Snyk] Fix for 1 vulnerabilities ryan-ally/docs#239

Open

mongoloidkhulmikuki366385 mentioned this issue Dec 1, 2023

[Snyk] Fix for 1 vulnerabilities mongoloidkhulmikuki366385/docs#25

Open

aliscco mentioned this issue Dec 1, 2023

[Snyk] Fix for 7 vulnerabilities aliscco/docs#285

Open

mongoloidkhulmikuki366385 mentioned this issue Dec 1, 2023

[Snyk] Fix for 1 vulnerabilities mongoloidkhulmikuki366385/docs#26

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do `installation` and `installation_repository` payloads have the property `installation` 100% of the times? #516

Do `installation` and `installation_repository` payloads have the property `installation` 100% of the times? #516

oscard0m commented Oct 14, 2020 •

edited

Loading

welcome bot commented Oct 14, 2020

lucascosti commented Oct 16, 2020

oscard0m commented Oct 16, 2020

lucascosti commented Oct 18, 2020 •

edited

Loading

oscard0m commented Oct 18, 2020

lucascosti commented Oct 18, 2020

Kerruba commented Oct 30, 2020

lucascosti commented Nov 3, 2020

This comment has been minimized.

oscard0m commented Dec 10, 2020

Do installation and installation_repository payloads have the property installation 100% of the times? #516

Do installation and installation_repository payloads have the property installation 100% of the times? #516

Comments

oscard0m commented Oct 14, 2020 • edited Loading

What article on docs.github.com is affected?

What part(s) of the article would you like to see updated?

Additional information

Context:

welcome bot commented Oct 14, 2020

lucascosti commented Oct 16, 2020

oscard0m commented Oct 16, 2020

lucascosti commented Oct 18, 2020 • edited Loading

oscard0m commented Oct 18, 2020

lucascosti commented Oct 18, 2020

Kerruba commented Oct 30, 2020

lucascosti commented Nov 3, 2020

This comment has been minimized.

oscard0m commented Dec 10, 2020

Do `installation` and `installation_repository` payloads have the property `installation` 100% of the times? #516

Do `installation` and `installation_repository` payloads have the property `installation` 100% of the times? #516

oscard0m commented Oct 14, 2020 •

edited

Loading

lucascosti commented Oct 18, 2020 •

edited

Loading