Secret Scanning Alert
This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "About secret scanning." For information about the API to manage secret scanning alerts, see "Secret scanning" in the REST API documentation.
Actions
| Action | Sent when |
|---|---|
assigned | A secret scanning alert was assigned. |
created | A secret scanning alert was created. |
metadata-created | Metadata was created for a secret scanning alert. |
metadata-removed | Metadata was removed from a secret scanning alert. |
publicly-leaked | A secret scanning alert was detected in a public repo. |
reopened | A previously closed secret scanning alert was reopened. |
resolved | A secret scanning alert was closed. |
unassigned | A secret scanning alert was unassigned. |
validated | A secret scanning alert was validated. |
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 | |
alert | object | Yes | |
assignee | object | No | A GitHub user. |
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 |
repository | object | Yes | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
sender | object | No | A GitHub user. |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.