api_function_getgithubactionswebhookeventpayload

Get-GitHubActionsWebhookEventPayload

• Type: Function
• In Version: >= v0.3.0
• Alias:
  • Get-GitHubActionsEvent
  • Get-GitHubActionsPayload
  • Get-GitHubActionsWebhookEvent
  • Get-GitHubActionsWebhookPayload

Description

Get-GitHubActionsWebhookEventPayload [-AsHashtable]

Get the complete webhook event payload.

Parameter

AsHashtable

[Optional] <Switch> Whether to output as hashtable instead of object.

• Position: Named
• Accept Pipeline Input By Property Name: False ❌
• Alias:
  • ToHashtable

Depth

👎 Deprecated: This is officially deprecated, maybe throw warning in the latest version, and maybe remove in the future version.

(< v1.1.0) [Optional] <UInt16> Set the maximum depth the JSON input is allowed to have.

• Default Value:

  1024

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌

NoEnumerate

👎 Deprecated: This is officially deprecated, maybe throw warning in the latest version, and maybe remove in the future version.

(< v1.1.0) [Optional] <Switch> Specify that output is not enumerated; Setting this parameter causes arrays to be sent as a single object instead of sending every element separately, this guarantees that JSON can be round-tripped via Cmdlet ConvertTo-Json.

• Position: Named
• Accept Pipeline Input By Property Name: False ❌

Output

• <Hashtable> Webhook event payload as hashtable.
• <PSCustomObject> Webhook event payload as object.