failed most likely due to lack of authentication. Reason: "installation" key missing in webhook event payload #2250

kaxada · 2022-07-11T14:53:56Z

kaxada
Jul 11, 2022

I am trying to create a github app that receives webhooks events. As soon as an issue is created, the app will read content in the applicant-welcome.md and then create a comment with that content.

for some reason, I can't tell why, after supplying all the parameters to the app instance I still get:

RequestError [HttpError]: Unauthorized. "POST /repos/{owner}/{repo}/issues/{issue_number}/comments" failed most likely due to lack of authentication. Reason: "installation" key missing in webhook event payload

Does anybody know how I can go about this?

code is below

const { App, createNodeMiddleware, Octokit } = require("octokit")
const { parsed: envs } = require("dotenv").config();
const SmeeClient = require("smee-client");


// instantiate Github App
const app = new App({
  appId: envs.appId,
  privateKey: envs.privateKey,
  oauth: {
    clientId: envs.clientId,
    clientSecret: envs.clientSecret,
  },
  webhooks: { secret: envs.webhookSecret },
});



app.webhooks.on("issues.opened", async ({ octokit, payload }) => {


  const {data: {content}} = await octokit.rest.repos.getContent({
    owner: payload.repository.owner.login,
    repo: payload.repository.name,
    path: ".github/applicant-welcome.md"
  })

  await octokit.rest.issues.createComment({
    owner: payload.repository.owner.login,
    repo: payload.repository.name,
    issue_number: payload.issue.number,
    body: content
  }).then(()=>console.log("comment created")).catch(err=>console.error(err))
})




// create local server to receive webhooks
require("http").createServer(createNodeMiddleware(app)).listen(envs.PORT);

//connect local server to network client in development
if (process.env.NODE_ENV !== "production") {
  const smee = new SmeeClient({
    source: "https://smee.io/badging",
    target: `http://localhost:${process.env.PORT}/api/github/webhooks`,
    logger: console,
  });
  smee.start();
}

module.exports = { app };

Answered by timrogers

Jul 12, 2022

The message seems to suggest that there is data missing from the webhook payload that is expected - namely the installation key. Would you be able to log payload in your app.webhooks.on callback, and share the output here?

View full answer

kaxada · 2022-07-11T14:54:09Z

kaxada
Jul 11, 2022
Author

@gr2m

0 replies

wolfy1339 · 2022-07-11T14:56:19Z

wolfy1339
Jul 11, 2022
Collaborator

Do you have the proper permissions on the app?

You need to set the repository contents permission to a minimum of read
And you also need to have the Issues permission set to write

1 reply

kaxada Jul 11, 2022
Author

Both repository content and issues permissions are set to read and write access

timrogers · 2022-07-12T17:21:35Z

timrogers
Jul 12, 2022

The message seems to suggest that there is data missing from the webhook payload that is expected - namely the installation key. Would you be able to log payload in your app.webhooks.on callback, and share the output here?

4 replies

gr2m Jul 12, 2022
Maintainer

what is odd is that the error message seems to be about the POST /repos/{owner}/{repo}/issues/{issue_number}/comments request, which is the 2nd request the event handler sends.

Both repository content and issues permissions are set to read and write access

did you maybe update the app permission after it was created, from issues:read to issues:write? If so, you will have to accept the new permission in the installation, even if it's your own user account or organization

timrogers Jul 12, 2022

This error message does seem to be triggered in a very specific place under very specific conditions, so it's extremely weird that it would happen for the second request and not the first 🤔

@kaxada Just to confirm, is the code above the exact code that triggers the RequestError [HttpError]: Unauthorized. "POST /repos/{owner}/{repo}/issues/{issue_number}/comments" failed most likely due to lack of authentication. Reason: "installation" key missing in webhook event payload error?

kaxada Jul 13, 2022
Author

@timrogers the code above is the very code that produces the error. actually, the payload doesn't have the installation key and I am wondering what step I missed. for brevity, here is the payload.

{
  action: 'opened',
  issue: {
    url: 'https://api.github.com/repos/Badging-Tests/badging-events/issues/1',
    repository_url: 'https://api.github.com/repos/Badging-Tests/badging-events',
    labels_url: 'https://api.github.com/repos/Badging-Tests/badging-events/issues/1/labels{/name}',
    comments_url: 'https://api.github.com/repos/Badging-Tests/badging-events/issues/1/comments',
    events_url: 'https://api.github.com/repos/Badging-Tests/badging-events/issues/1/events',
    html_url: 'https://github.com/Badging-Tests/badging-events/issues/1',
    id: 1300775042,
    node_id: 'I_kwDOHpBJYM5NiECC',
    number: 1,
    title: 'test issue ',
    user: {
      login: 'kaxada',
      id: 54111299,
      node_id: 'MDQ6VXNlcjU0MTExMjk5',
      avatar_url: 'https://avatars.githubusercontent.com/u/54111299?v=4',
      gravatar_id: '',
      url: 'https://api.github.com/users/kaxada',
      html_url: 'https://github.com/kaxada',
      followers_url: 'https://api.github.com/users/kaxada/followers',
      following_url: 'https://api.github.com/users/kaxada/following{/other_user}',
      gists_url: 'https://api.github.com/users/kaxada/gists{/gist_id}',
      starred_url: 'https://api.github.com/users/kaxada/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/kaxada/subscriptions',
      organizations_url: 'https://api.github.com/users/kaxada/orgs',
      repos_url: 'https://api.github.com/users/kaxada/repos',
      events_url: 'https://api.github.com/users/kaxada/events{/privacy}',
      received_events_url: 'https://api.github.com/users/kaxada/received_events',
      type: 'User',
      site_admin: false
    },
    labels: [],
    state: 'open',
    locked: false,
    assignee: null,
    assignees: [],
    milestone: null,
    comments: 0,
    created_at: '2022-07-11T14:14:24Z',
    updated_at: '2022-07-11T14:14:24Z',
    closed_at: null,
    author_association: 'NONE',
    active_lock_reason: null,
    body: null,
    reactions: {
      url: 'https://api.github.com/repos/Badging-Tests/badging-events/issues/1/reactions',
      total_count: 0,
      '+1': 0,
      '-1': 0,
      laugh: 0,
      hooray: 0,
      confused: 0,
      heart: 0,
      rocket: 0,
      eyes: 0
    },
    timeline_url: 'https://api.github.com/repos/Badging-Tests/badging-events/issues/1/timeline',
    performed_via_github_app: null,
    state_reason: null
  },
  repository: {
    id: 512772448,
    node_id: 'R_kgDOHpBJYA',
    name: 'badging-events',
    full_name: 'Badging-Tests/badging-events',
    private: false,
    owner: {
      login: 'Badging-Tests',
      id: 109084972,
      node_id: 'O_kgDOBoCBLA',
      avatar_url: 'https://avatars.githubusercontent.com/u/109084972?v=4',
      gravatar_id: '',
      url: 'https://api.github.com/users/Badging-Tests',
      html_url: 'https://github.com/Badging-Tests',
      followers_url: 'https://api.github.com/users/Badging-Tests/followers',
      following_url: 'https://api.github.com/users/Badging-Tests/following{/other_user}',
      gists_url: 'https://api.github.com/users/Badging-Tests/gists{/gist_id}',
      starred_url: 'https://api.github.com/users/Badging-Tests/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/Badging-Tests/subscriptions',
      organizations_url: 'https://api.github.com/users/Badging-Tests/orgs',
      repos_url: 'https://api.github.com/users/Badging-Tests/repos',
      events_url: 'https://api.github.com/users/Badging-Tests/events{/privacy}',
      received_events_url: 'https://api.github.com/users/Badging-Tests/received_events',
      type: 'Organization',
      site_admin: false
    },
    html_url: 'https://github.com/Badging-Tests/badging-events',
    description: 'for test purposes ',
    fork: false,
    url: 'https://api.github.com/repos/Badging-Tests/badging-events',
    forks_url: 'https://api.github.com/repos/Badging-Tests/badging-events/forks',
    keys_url: 'https://api.github.com/repos/Badging-Tests/badging-events/keys{/key_id}',
    collaborators_url: 'https://api.github.com/repos/Badging-Tests/badging-events/collaborators{/collaborator}',
    teams_url: 'https://api.github.com/repos/Badging-Tests/badging-events/teams',
    hooks_url: 'https://api.github.com/repos/Badging-Tests/badging-events/hooks',
    issue_events_url: 'https://api.github.com/repos/Badging-Tests/badging-events/issues/events{/number}',
    events_url: 'https://api.github.com/repos/Badging-Tests/badging-events/events',
    assignees_url: 'https://api.github.com/repos/Badging-Tests/badging-events/assignees{/user}',
    branches_url: 'https://api.github.com/repos/Badging-Tests/badging-events/branches{/branch}',
    tags_url: 'https://api.github.com/repos/Badging-Tests/badging-events/tags',
    blobs_url: 'https://api.github.com/repos/Badging-Tests/badging-events/git/blobs{/sha}',
    git_tags_url: 'https://api.github.com/repos/Badging-Tests/badging-events/git/tags{/sha}',
    git_refs_url: 'https://api.github.com/repos/Badging-Tests/badging-events/git/refs{/sha}',
    trees_url: 'https://api.github.com/repos/Badging-Tests/badging-events/git/trees{/sha}',
    statuses_url: 'https://api.github.com/repos/Badging-Tests/badging-events/statuses/{sha}',
    languages_url: 'https://api.github.com/repos/Badging-Tests/badging-events/languages',
    stargazers_url: 'https://api.github.com/repos/Badging-Tests/badging-events/stargazers',
    contributors_url: 'https://api.github.com/repos/Badging-Tests/badging-events/contributors',
    subscribers_url: 'https://api.github.com/repos/Badging-Tests/badging-events/subscribers',
    subscription_url: 'https://api.github.com/repos/Badging-Tests/badging-events/subscription',
    commits_url: 'https://api.github.com/repos/Badging-Tests/badging-events/commits{/sha}',
    git_commits_url: 'https://api.github.com/repos/Badging-Tests/badging-events/git/commits{/sha}',
    comments_url: 'https://api.github.com/repos/Badging-Tests/badging-events/comments{/number}',
    issue_comment_url: 'https://api.github.com/repos/Badging-Tests/badging-events/issues/comments{/number}',
    contents_url: 'https://api.github.com/repos/Badging-Tests/badging-events/contents/{+path}',
    compare_url: 'https://api.github.com/repos/Badging-Tests/badging-events/compare/{base}...{head}',
    merges_url: 'https://api.github.com/repos/Badging-Tests/badging-events/merges',
    archive_url: 'https://api.github.com/repos/Badging-Tests/badging-events/{archive_format}{/ref}',
    downloads_url: 'https://api.github.com/repos/Badging-Tests/badging-events/downloads',
    issues_url: 'https://api.github.com/repos/Badging-Tests/badging-events/issues{/number}',
    pulls_url: 'https://api.github.com/repos/Badging-Tests/badging-events/pulls{/number}',
    milestones_url: 'https://api.github.com/repos/Badging-Tests/badging-events/milestones{/number}',
    notifications_url: 'https://api.github.com/repos/Badging-Tests/badging-events/notifications{?since,all,participating}',
    labels_url: 'https://api.github.com/repos/Badging-Tests/badging-events/labels{/name}',
    releases_url: 'https://api.github.com/repos/Badging-Tests/badging-events/releases{/id}',
    deployments_url: 'https://api.github.com/repos/Badging-Tests/badging-events/deployments',
    created_at: '2022-07-11T13:40:58Z',
    updated_at: '2022-07-11T13:40:58Z',
    pushed_at: '2022-07-11T13:43:12Z',
    git_url: 'git://github.com/Badging-Tests/badging-events.git',
    ssh_url: '[email protected]:Badging-Tests/badging-events.git',
    clone_url: 'https://github.com/Badging-Tests/badging-events.git',
    svn_url: 'https://github.com/Badging-Tests/badging-events',
    homepage: null,
    size: 0,
    stargazers_count: 0,
    watchers_count: 0,
    language: null,
    has_issues: true,
    has_projects: true,
    has_downloads: true,
    has_wiki: true,
    has_pages: false,
    forks_count: 0,
    mirror_url: null,
    archived: false,
    disabled: false,
    open_issues_count: 1,
    license: {
      key: 'mit',
      name: 'MIT License',
      spdx_id: 'MIT',
      url: 'https://api.github.com/licenses/mit',
      node_id: 'MDc6TGljZW5zZTEz'
    },
    allow_forking: true,
    is_template: false,
    web_commit_signoff_required: false,
    topics: [],
    visibility: 'public',
    forks: 0,
    open_issues: 1,
    watchers: 0,
    default_branch: 'main'
  },
  organization: {
    login: 'Badging-Tests',
    id: 109084972,
    node_id: 'O_kgDOBoCBLA',
    url: 'https://api.github.com/orgs/Badging-Tests',
    repos_url: 'https://api.github.com/orgs/Badging-Tests/repos',
    events_url: 'https://api.github.com/orgs/Badging-Tests/events',
    hooks_url: 'https://api.github.com/orgs/Badging-Tests/hooks',
    issues_url: 'https://api.github.com/orgs/Badging-Tests/issues',
    members_url: 'https://api.github.com/orgs/Badging-Tests/members{/member}',
    public_members_url: 'https://api.github.com/orgs/Badging-Tests/public_members{/member}',
    avatar_url: 'https://avatars.githubusercontent.com/u/109084972?v=4',
    description: null
  },
  sender: {
    login: 'kaxada',
    id: 54111299,
    node_id: 'MDQ6VXNlcjU0MTExMjk5',
    avatar_url: 'https://avatars.githubusercontent.com/u/54111299?v=4',
    gravatar_id: '',
    url: 'https://api.github.com/users/kaxada',
    html_url: 'https://github.com/kaxada',
    followers_url: 'https://api.github.com/users/kaxada/followers',
    following_url: 'https://api.github.com/users/kaxada/following{/other_user}',
    gists_url: 'https://api.github.com/users/kaxada/gists{/gist_id}',
    starred_url: 'https://api.github.com/users/kaxada/starred{/owner}{/repo}',
    subscriptions_url: 'https://api.github.com/users/kaxada/subscriptions',
    organizations_url: 'https://api.github.com/users/kaxada/orgs',
    repos_url: 'https://api.github.com/users/kaxada/repos',
    events_url: 'https://api.github.com/users/kaxada/events{/privacy}',
    received_events_url: 'https://api.github.com/users/kaxada/received_events',
    type: 'User',
    site_admin: false
  }
}

@gr2m I actually had to update all the permission of the app before I installed it to the repository. I set almost all to read and write since I didn't want to come back and update permissions during further development.

gr2m Jul 14, 2022
Maintainer

the payload doesn't have the installation key

Did you setup the webhook manually at https://github.com/Badging-Tests/badging-events/settings/hooks? That would explain why there is no installation key. You don't need to setup webhooks manually when using GitHub Actions, they retrieve webhooks once you install the app, as long as you

enabled webhooks in the app settings
selected the right webhook events in the "Permissions & events" app settings

kaxada · 2022-07-15T04:43:52Z

kaxada
Jul 15, 2022
Author

@gr2m your last message reply to the above thread solved the problem. I think there was a conflict from the start. Now everything works like a charm. thank you

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

failed most likely due to lack of authentication. Reason: "installation" key missing in webhook event payload #2250

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 4 comments 5 replies

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

failed most likely due to lack of authentication. Reason: "installation" key missing in webhook event payload #2250

kaxada Jul 11, 2022

Replies: 4 comments · 5 replies

kaxada Jul 11, 2022 Author

wolfy1339 Jul 11, 2022 Collaborator

kaxada Jul 11, 2022 Author

timrogers Jul 12, 2022

gr2m Jul 12, 2022 Maintainer

timrogers Jul 12, 2022

kaxada Jul 13, 2022 Author

gr2m Jul 14, 2022 Maintainer

kaxada Jul 15, 2022 Author

kaxada
Jul 11, 2022

Replies: 4 comments 5 replies

kaxada
Jul 11, 2022
Author

wolfy1339
Jul 11, 2022
Collaborator

kaxada Jul 11, 2022
Author

timrogers
Jul 12, 2022

gr2m Jul 12, 2022
Maintainer

kaxada Jul 13, 2022
Author

gr2m Jul 14, 2022
Maintainer

kaxada
Jul 15, 2022
Author