Developer Documentation
Citrix Daas SDK

Add-MonitorWebhookProfile

November 26, 2024
Contributed by: 
C

Creates a new webhook profile.

Syntax

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

Description

This cmdlet creates a new webhook profile with the specified properties. A webhook profile allows you to configure an endpoint for receiving notifications.

Examples

EXAMPLE 1

Demonstrates how to create a new webhook profile with a specified name, 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"
Add-MonitorWebhookProfile -Name "webhookprofile1" -Description "Description" -Url $url -Headers $headers -PayloadFormat $payloads
<!--NeedCopy-->

Parameters

-Name

Specifies the name of the new webhook profile.

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

-Description

Provides a description for the new webhook profile.

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

-Url

The URL of the webhook endpoint where notifications or data will be sent.

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 created successfully. Returns true if successful; otherwise, false.

Add-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.