What is permission needed to get data for repository webhook list deliveries REST API?

[wraschke]

Select Topic Area

Question

Body

https://docs.github.com/en/rest/repos/webhooks?apiVersion=2022-11-28#list-deliveries-for-a-repository-webhook describes the API that will return deliveries of a webhook configured in a repository.

What is the permission needed, attached to a classic personal access token, for calling this API? The token I am passing into Authorization header is for a user with no admin privilege. The call returned a 404. For PD purposes, I gave this user admin privilege (temporarily), then saw the API call return data.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬

[Chanduporalla]

To call the List deliveries for a repository webhook API, the user needs admin-level access to the repository.

The reason you received a 404 error initially is that the token being used did not have sufficient permissions, which is why the call failed when the user didn't have admin privileges. When you temporarily assigned admin privileges, the call succeeded because admin access is required to retrieve webhook deliveries.
Required Permissions:

For classic personal access tokens (PAT), you need the following scope:
    repo: This gives full control of private repositories, including access to repository settings like webhooks, which require admin-level privileges.

Specifically, the API endpoint for webhook deliveries requires that the user has:
    Admin privileges on the repository (i.e., the user must be an admin of the repository in question).

Steps:

Ensure that the personal access token has the repo scope enabled.
The user calling the API must have admin privileges on the repository to successfully retrieve webhook deliveries.

If you want to keep using the same user but without permanently granting admin privileges, you could create a dedicated admin user or service account for interacting with APIs that require admin access.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬