Developer Documentation
Citrix Virtual Apps and Desktops SDK
2603 CR 2511 CR 2503 CR 2411 CR 2407 CR 2507 LTSR 2402 LTSR 2203 LTSR
View PDF

Test-MonitorWebhookProfile

May 4, 2026
Contributed by: 
C

Introduced in: Citrix Virtual Apps and Desktop 7 2411

Tests a webhook profile configuration.

Syntax

Test-MonitorWebhookProfile
    -Url <String>
    -Headers <System.Collections.Generic.Dictionary`2[System.String,System.String]>
    -PayloadFormat <String>
    -MethodType <WebhookMethodType>
    [-LoggingId <Guid>]
    [-SkipCertificateValidation]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

Verifies the functionality of a webhook profile by sending a test payload to the specified URL with the provided headers and payload format. It returns a boolean indicating the success or failure of the test.

Examples

EXAMPLE 1

Tests the webhook configuration by sending a test payload to the specified URL with the given 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"
Test-MonitorWebhookProfile -Url $url -Headers $headers -PayloadFormat $payloads -MethodType POST
<!--NeedCopy-->

Parameters

-Url

Url of 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

-MethodType

http method type to make call to webhook Possible values are POST PUT

Type: WebhookMethodType
Accepted values: POST, PUT
Position: Named
Default value: POST
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2503

-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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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 test was successful.

Test-MonitorWebhookProfile
May 4, 2026
Contributed by: 
C
May 4, 2026
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.