88 lines
5.0 KiB
Markdown
88 lines
5.0 KiB
Markdown
---
|
|
title: Managing global webhooks
|
|
intro: 'Site administrators can view, add, edit, and delete global webhooks to track events for the enterprise.'
|
|
redirect_from:
|
|
- /enterprise/admin/user-management/about-global-webhooks
|
|
- /enterprise/admin/user-management/managing-global-webhooks
|
|
- /admin/user-management/managing-global-webhooks
|
|
versions:
|
|
ghes: '*'
|
|
ghae: '*'
|
|
type: how_to
|
|
topics:
|
|
- Enterprise
|
|
- Webhooks
|
|
---
|
|
## 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
|
|
|
|
|
|
|
|
{% data reusables.enterprise_user_management.manage-global-webhooks-api %}
|
|
|
|
## Adding a global webhook
|
|
|
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
|
{% data reusables.enterprise-accounts.settings-tab %}
|
|
{% data reusables.enterprise-accounts.hooks-tab %}
|
|
5. Click **Add webhook**.
|
|
|
|
6. Type the URL where you'd like to receive payloads.
|
|
|
|
7. Optionally, use the **Content type** drop-down menu, and click a payload format.
|
|
|
|
8. Optionally, in the **Secret** field, type a string to use as a `secret` key.
|
|
|
|
9. Optionally, if you would not like {% data variables.product.prodname_ghe_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**.
|
|
|
|
|
|
{% warning %}
|
|
|
|
**Warning:** SSL verification helps ensure that hook payloads are delivered securely. We do not recommend disabling SSL verification.
|
|
|
|
{% endwarning %}
|
|
10. Decide if you'd like this webhook to trigger for every event or for selected events:
|
|
|
|
- For every event, select **Send me everything**.
|
|
- To choose specific events, select **Let me select individual events**.
|
|
11. If you chose to select individual events, select whether to trigger this webhook for organization or user activity.
|
|
|
|
12. Confirm that the **Active** checkbox is selected (it is selected by default).
|
|
|
|
13. Click **Add webhook**.
|
|
|
|
## Editing a global webhook
|
|
|
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
|
{% data reusables.enterprise-accounts.settings-tab %}
|
|
{% data reusables.enterprise-accounts.hooks-tab %}
|
|
5. Next to the webhook you'd like to edit, click **Edit**.
|
|
|
|
6. Update the webhook's settings.
|
|
7. Click **Update webhook**.
|
|
|
|
## Deleting a global webhook
|
|
|
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
|
{% data reusables.enterprise-accounts.settings-tab %}
|
|
{% data reusables.enterprise-accounts.hooks-tab %}
|
|
5. Next to the webhook you'd like to delete, click **Delete**.
|
|
|
|
6. Read the information about deleting a webhook, then click **Yes, delete webhook**.
|
|
|
|
|
|
## Viewing recent deliveries and responses
|
|
|
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
|
{% data reusables.enterprise-accounts.settings-tab %}
|
|
{% data reusables.enterprise-accounts.hooks-tab %}
|
|
5. In the list of webhooks, click the webhook for which you'd like to see deliveries.
|
|
|
|
6. Under "Recent deliveries", click a delivery to view details.
|
|
|