Custom Property
This event occurs when there is activity relating to a custom property.
Actions
| Action | Sent when |
|---|---|
created | A new custom property was created. |
deleted | A custom property was deleted. |
promoted-to-enterprise | A custom property was promoted to an enterprise. |
updated | A custom property was updated. |
Payload
Fields of the delivery for the first action above. Every action shares the event's core fields.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | Yes | |
definition | object | Yes | Custom property defined on an organization |
enterprise | object | No | An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured |
installation | object | No | The GitHub App installation. Webhook payloads contain the installation property when the event is configured |
organization | object | No | A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an |
sender | object | No | A GitHub user. |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission.