New-VcWebhook¶
SYNOPSIS¶
Create a new webhook
SYNTAX¶
EventName (Default)¶
New-VcWebhook -Name <String> -Url <String> -EventName <String[]> [-Secret <String>] [-CriticalOnly] [-PassThru]
[-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
EventType¶
New-VcWebhook -Name <String> -Url <String> -EventType <String[]> [-Secret <String>] [-CriticalOnly] [-PassThru]
[-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
Create a new webhook
EXAMPLES¶
EXAMPLE 1¶
Create a new webhook for one event type
EXAMPLE 2¶
New-VcWebhook -Name 'MyWebhook' -Url 'https://my.com/endpoint' -EventType 'Authentication', 'Certificates', 'Applications'
Create a new webhook with multiple event types
EXAMPLE 3¶
New-VcWebhook -Name 'MyWebhook' -Url 'https://my.com/endpoint' -EventName 'Certificate Validation Started'
Create a new webhook with event names as opposed to event types. This will result in fewer messages received as opposed to subscribing at the event type level.
EXAMPLE 4¶
New-VcWebhook -Name 'MyWebhook' -Url 'https://my.com/endpoint' -EventType 'Certificates' -CriticalOnly
Subscribe to critical messages only for a specific event type
EXAMPLE 5¶
New-VcWebhook -Name 'MyWebhook' -Url 'https://my.com/endpoint' -EventType 'Authentication' -Secret 'MySecret'
Create a new webhook with optional secret
EXAMPLE 6¶
New-VcWebhook -Name 'MyWebhook' -Url 'https://my.com/endpoint' -EventType 'Authentication' -PassThru
Create a new webhook returning the newly created object
PARAMETERS¶
-Name¶
Webhook name
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Url¶
Endpoint to be called when the event type/name is triggered. This should be the full url and will be validated during webhook creation.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EventType¶
One or more event types to trigger on. You can retrieve a list of possible values from the Event Log and filtering on Event Type.
Type: String[]
Parameter Sets: EventType
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EventName¶
One or more event names to trigger on.
Type: String[]
Parameter Sets: EventName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Secret¶
Secret value used to calculate signature which will be sent to the endpoint in the header
Type: String
Parameter Sets: (All)
Aliases: token
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CriticalOnly¶
Only subscribe to log messages deemed as critical
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PassThru¶
Return newly created webhook object
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-VenafiSession¶
Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TLSPC key can also provided.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
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.