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 <int>] [-Context <Object>] [<CommonParameters>]

ByID

Get-GitHubAppWebhookDelivery -ID <string> [-Context <Object>] [<CommonParameters>]

Redelivery

Get-GitHubAppWebhookDelivery -NeedingRedelivery [-TimeSpan <int>] [-PerPage <int>]
 [-Context <Object>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

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

-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: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ID

The ID of the delivery.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ByID
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-NeedingRedelivery

Only the ones to redeliver.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Redelivery
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PerPage

The number of results per page (max 100).

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Redelivery
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: ByList
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-TimeSpan

The timespan to check for redeliveries in hours.

Type: System.Int32
DefaultValue: -2
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Redelivery
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

GitHubWebhookDelivery

{{ Fill in the Description }}

NOTES

Get a webhook configuration for an app

RELATED LINKS