This version of GitHub Enterprise was discontinued on 2021-06-09. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.
Managing global webhooks
Site administrators can view, add, edit, and delete global webhooks to track events for the enterprise.
About global webhooks
You can use global webhooks to automatically monitor, respond to, or enforce rules for user and organization management for your enterprise. For example, you can configure your webhooks to execute whenever:
- A user account is created or deleted
- An organization is created or deleted
- A collaborator is added to or removed from a repository
- A repository is forked
You can also use the GitHub Enterprise Server APIs to manage global webhooks. For a complete list of actions, see "Global webhooks."
Adding a global webhook
-
Navigate to your enterprise account by visiting
https://HOSTNAME/enterprises/ENTERPRISE-NAME, replacingHOSTNAMEwith your instance's hostname andENTERPRISE-NAMEwith your enterprise account's name. -
In the enterprise account sidebar, click Settings. 👁 Settings tab in the enterprise account sidebar
-
Under " Settings", click Hooks. 👁 Hooks tab in the enterprise account settings sidebar
-
Click Add webhook. 👁 Add webhook button on Webhooks page in Admin center
-
Type the URL where you'd like to receive payloads. 👁 Field to type a payload URL
-
Optionally, use the Content type drop-down menu, and click a payload format. 👁 Drop-down menu listing content type options
-
Optionally, in the Secret field, type a string to use as a
secretkey. 👁 Field to type a string to use as a secret key -
Optionally, if you would not like GitHub Enterprise Server to verify SSL certificates when delivering payloads, click Disable SSL verification. Read the information about SSL verification, then click I understand my webhooks may not be secure. 👁 Button for disabling SSL verification
Warning: SSL verification helps ensure that hook payloads are delivered securely. We do not recommend disabling SSL verification.
-
Decide if you'd like this webhook to trigger for every event or for selected events: 👁 Radio buttons with options to receive payloads for every event or selected events
- For every event, select Send me everything.
- To choose specific events, select Let me select individual events.
-
If you chose to select individual events, select whether to trigger this webhook for organization or user activity. 👁 Checkboxes for organization and user events
-
Confirm that the Active checkbox is selected (it is selected by default). 👁 Selected Active checkbox
-
Click Add webhook.
Editing a global webhook
-
Navigate to your enterprise account by visiting
https://HOSTNAME/enterprises/ENTERPRISE-NAME, replacingHOSTNAMEwith your instance's hostname andENTERPRISE-NAMEwith your enterprise account's name. -
In the enterprise account sidebar, click Settings. 👁 Settings tab in the enterprise account sidebar
-
Under " Settings", click Hooks. 👁 Hooks tab in the enterprise account settings sidebar
-
Next to the webhook you'd like to edit, click Edit. 👁 Edit button next to a webhook
-
Update the webhook's settings.
-
Click Update webhook.
Deleting a global webhook
-
Navigate to your enterprise account by visiting
https://HOSTNAME/enterprises/ENTERPRISE-NAME, replacingHOSTNAMEwith your instance's hostname andENTERPRISE-NAMEwith your enterprise account's name. -
In the enterprise account sidebar, click Settings. 👁 Settings tab in the enterprise account sidebar
-
Under " Settings", click Hooks. 👁 Hooks tab in the enterprise account settings sidebar
-
Next to the webhook you'd like to delete, click Delete. 👁 Delete button next to a webhook
-
Read the information about deleting a webhook, then click Yes, delete webhook. 👁 Pop-up box with warning information and button to confirm deleting the webhook
Viewing recent deliveries and responses
-
Navigate to your enterprise account by visiting
https://HOSTNAME/enterprises/ENTERPRISE-NAME, replacingHOSTNAMEwith your instance's hostname andENTERPRISE-NAMEwith your enterprise account's name. -
In the enterprise account sidebar, click Settings. 👁 Settings tab in the enterprise account sidebar
-
Under " Settings", click Hooks. 👁 Hooks tab in the enterprise account settings sidebar
-
In the list of webhooks, click the webhook for which you'd like to see deliveries. 👁 List of webhooks with links to view each webhook
-
Under "Recent deliveries", click a delivery to view details. 👁 List of the webhook's recent deliveries with links to view details
