Editing webhooks

About editing webhooks

You can edit a webhook to change any of the settings that were selected when the webhook was initially created. For more information about the settings you can select while creating a webhook, see Creating webhooks.

Editing a repository webhook

You can edit a webhook that was created in a specific repository. You must be a repository owner or have admin access in the repository to edit webhooks in that repository.

You can use the web interface or the REST API to edit a repository webhook. For more information about using the REST API to edit a repository webhook, see REST API endpoints for repository webhooks.

1. On , navigate to the main page of the repository.

2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

   

3. In the left sidebar, click Webhooks.

4. Next to the webhook you'd like to edit, click Edit.

5. Make any desired changes to the webhook settings.

6. Click Update Webhook.

Editing an organization webhook

You can edit a webhook that was created in a specific organization. You must be an organization owner to edit webhooks in that organization.

You can use the web interface or the REST API to edit an organization webhook. For more information about using the REST API to create an organization webhook, see REST API endpoints for organization webhooks.

1. On , navigate to the main page of the repository.

2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

   

3. In the left sidebar, click Webhooks.

4. Next to the webhook you'd like to edit, click Edit.

5. Make any desired changes to the webhook settings.

6. Click Update Webhook.

Editing a Marketplace webhook

You can edit a webhook that was created for an app that you published in Marketplace. Only the owner of the app, or an app manager for the organization that owns the app, can edit a Marketplace webhook. For more information, see Webhook events for the Marketplace API.

1. Navigate to your Marketplace listing page.
2. Next to the Marketplace listing that you want to view webhook deliveries for, click Manage listing.
3. In the sidebar, click Webhook.
4. Make any desired changes to the webhook settings.
5. Click Update Webhook.

Editing a Sponsors webhook

You can edit a webhook that was created for a Sponsors account. Only the owner of the sponsored account can edit sponsorship webhooks for that account.

1. In the upper-right corner of any page, click your profile photo, then click Your sponsors.
2. Next to the account you want to edit a webhook for, click Dasard.
3. In the left sidebar, click Webhooks.
4. Next to the webhook you'd like to edit, click Edit.
5. Make any desired changes to the webhook settings.
6. Click Update Webhook.

Editing webhooks for a App

Each App has one webhook. You cannot delete the webhook, but you can activate or deactivate the webhook, change the webhook events that the webhook subscribes to, or make changes to other basic settings for the webhook.

The owner of a App can edit the webhook configuration for the app. If an organization has designated any app managers for a App owned by the organization, the app managers can also edit the webhook configuration. For more information, see Using webhooks with Apps.

1. In the upper-right corner of any page on , click your profile photo.
2. Navigate to your account settings.
   • For an app owned by a personal account, click Settings.
   • For an app owned by an organization:
     1. Click Your organizations.
     2. To the right of the organization, click Settings.
3. In the left sidebar, click Developer settings.
4. In the left sidebar, click Apps.
5. Next to the App that you want to update the webhook configuration for, click Edit.
6. To edit the basic webhook settings:
   1. Under "Webhook", any desired changes to the webhook settings.
   2. Click Save changes.
7. To make changes to the events that the webhook is subscribed to:

   1. In the sidebar, click Permissions & events.

   2. The specific webhook events that you can select for your App registration are determined by the type of permissions you selected for your app. You will first need to select the permissions you would like your app to have, and then you can subscribe your app to webhook events that are related to that set of permissions.

      Under the sections "Repository permissions," "Organization permissions," and "Account permissions," select the permissions that are required for the events your app will subscribe to. For more information, see Choosing permissions for a App. For more information about things to consider when changing the permissions, see Modifying a App registration.

   3. Under "Subscribe to Events," select the webhook events you would like your App to receive.

   4. Click Save changes.

You can use the REST API to edit the webhook configuration for a App. For more information about using the REST API to view recent deliveries, see REST API endpoints for App webhooks.