Developer Documentation
Citrix Daas SDK

Test-MonitorWebhookProfile

November 26, 2024
Contributed by: 
C

Tests a webhook profile configuration.

Syntax

Test-MonitorWebhookProfile
    -Url <String>
    -Headers <System.Collections.Generic.Dictionary`2[System.String,System.String]>
    -PayloadFormat <String>
    [-LoggingId <Guid>]
    [<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
<!--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

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

Test-MonitorWebhookProfile
November 26, 2024
Contributed by: 
C
November 26, 2024
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.