Get-GitHubAppWebhookDelivery¶
SYNOPSIS¶
List deliveries for an app webhook or get a delivery for an app webhook by ID.
SYNTAX¶
ByList (Default)¶
Get-GitHubAppWebhookDelivery [-PerPage <Int32>] [-Context <Object>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
ByID¶
Get-GitHubAppWebhookDelivery -ID <String> [-Context <Object>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Redelivery¶
Get-GitHubAppWebhookDelivery [-NeedingRedelivery] [-TimeSpan <Int32>] [-PerPage <Int32>] [-Context <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Returns a list of webhook deliveries or a specific delivery for the webhook configured for a GitHub App.
You must use a JWT to access this endpoint.
EXAMPLES¶
EXAMPLE 1¶
Get-GitHubAppWebhookDelivery
Returns a list of webhook deliveries for the webhook for the authenticated app.
EXAMPLE 2¶
Get-GitHubAppWebhookDelivery -ID 123456
Returns the webhook delivery with the ID 123456 for the authenticated app.
PARAMETERS¶
-ID¶
The ID of the delivery.
Type: String
Parameter Sets: ByID
Aliases: DeliveryID, delivery_id
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NeedingRedelivery¶
Only the ones to redeliver.
Type: SwitchParameter
Parameter Sets: Redelivery
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-TimeSpan¶
The timespan to check for redeliveries in hours.
Type: Int32
Parameter Sets: Redelivery
Aliases:
Required: False
Position: Named
Default value: -2
Accept pipeline input: False
Accept wildcard characters: False
-PerPage¶
The number of results per page (max 100).
Type: Int32
Parameter Sets: ByList, Redelivery
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Context¶
The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-GitHubContext)
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
OUTPUTS¶
GitHubWebhook[]¶
NOTES¶
Get a delivery for an app webhook Get a webhook configuration for an app