Secret Scanning Scan
This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "About secret scanning."
Actions
| Action | Sent when |
|---|---|
completed | A secret scanning scan was completed. |
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 | |
type | string | Yes | What type of scan was completed |
source | string | Yes | What type of content was scanned |
started_at | string | Yes | The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. |
completed_at | string | Yes | The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. |
secret_types | array<string> | No | List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates |
custom_pattern_name | string | No | If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated |
custom_pattern_scope | string | No | If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated |
repository | object | No | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
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 "Secret scanning alerts" repository permission.