Citrix Virtual Apps and Desktops 2411 SDK

Set-MonitorWebhookProfile

Introduced in: Citrix Virtual Apps and Desktop 7 2411

Updates an existing webhook profile.

Syntax

Set-MonitorWebhookProfile
   -Uid <Int64>
   -Name <String>
   -Description <String>
   -Url <String>
   -Headers <System.Collections.Generic.Dictionary`2[System.String,System.String]>
   -PayloadFormat <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Updates the properties of an existing webhook profile identified by its unique identifier (Uid). This cmdlet allows modifying the name, description, URL, headers, and payload format of the webhook profile.

Examples

EXAMPLE 1

Updates the webhook profile with Uid 1, setting a new description, URL, headers, and payload format.

$headers = [System.Collections.Generic.Dictionary[string,string]]::new()
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Basic *************")
$payloads = '{ "text": "$PAYLOAD" }'
$url ="https://url.net"
Set-MonitorWebhookProfile -Uid 1 -Name "webhookprofile1" -Description "Description" -Url $url -Headers $headers -PayloadFormat $payloads
<!--NeedCopy-->

Parameters

-Uid

The unique identifier of the webhook profile to update.

Type: Int64
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Name

The new name for the webhook profile.

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Description

The new description for the webhook profile.

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Url

The new URL for the webhook.

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Headers

Dictionary of headers for the webhook, where each key-value pair represents a header name and its value.

Type: System.Collections.Generic.Dictionary`2[System.String,System.String]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-PayloadFormat

Template for the data payload in JSON format to be sent to the webhook URL.

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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

None

You can’t pipe objects to this cmdlet.

Outputs

Boolean

Indicates whether the webhook profile was updated successfully.

Notes

Ensure the Uid provided corresponds to an existing webhook profile.

Set-MonitorWebhookProfile