29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
---
|
|
title: REST API endpoints for organization webhooks
|
|
allowTitleToDifferFromFilename: true
|
|
shortTitle: Webhooks
|
|
intro: Use the REST API to interact with webhooks in an organization.
|
|
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
|
|
fpt: '*'
|
|
ghec: '*'
|
|
ghes: '*'
|
|
topics:
|
|
- API
|
|
autogenerated: rest
|
|
---
|
|
|
|
## About organization webhooks
|
|
|
|
Organization webhooks allow your server to receive HTTP `POST` payloads whenever certain events happen in an organization. For more information, see "[AUTOTITLE](/webhooks)."
|
|
|
|
### Scopes and restrictions
|
|
|
|
You must be an organization owner{% ifversion custom-org-roles %} or have the "Manage organization webhooks" permission{% endif %} to use these endpoints. OAuth tokens require the `admin:org_hook` scope to use these endpoints.
|
|
|
|
In order to protect sensitive data which may be present in webhook configurations, we also enforce the following access control rules:
|
|
|
|
- {% data variables.product.prodname_oauth_apps %} cannot list, view, or edit webhooks which they did not create.
|
|
- Users cannot list, view, or edit webhooks which were created by {% data variables.product.prodname_oauth_apps %}.
|
|
|
|
<!-- Content after this section is automatically generated -->
|