Citrix Daas SDK

New-BrokerDesktopGroupWebhook

August 9, 2024

Contributed by:

C C

Create a webhook for the sepcified desktop group

Syntax

New-BrokerDesktopGroupWebhook
   -Address <String>
   -DesktopGroupUid <Int32>
   -OnEvent <WebhookTrigger>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

This cmdlet is used to create a webhook for the sepcified desktop group, that is invoked upon the specified event of the desktop group.

Examples

EXAMPLE 1

Creates a new webhook for the desktop group with Uid 1, that is to be invoked when a machine registers to the broker.

When it is invoked, a HTTP POST request is sent out to the address above with a JSON payload {“SamName”: “value”} where “value” is the SAM name of registering machine.

New-BrokerDesktopGroupWebhook -DesktopGroupUid 1 -OnEvent MachineRegistration -Address 'http://citrix.com/example'
<!--NeedCopy-->

Parameters

-Address

The URL of the webhook

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-DesktopGroupUid

The Uid of the desktop group to configure a webhook

Type:	Int32
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-OnEvent

The event upon that the webhook is invoked, currently the only supported event is MachineRegistration.

For MachineRegistration, when the webhook is invoked it is HTTP POST with a JSON payload of the format: {“SamName”: “value”} where the “value” is the SamName of the machine that is registering to the broker.

Type:	WebhookTrigger
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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

Citrix.Broker.Admin.SDK.DesktopGroupWebhook

The set of webhooks to be added to the desktop group can be piped into this cmdlet

Outputs

None

By default, this cmdlet returns no output.

Get-BrokerDesktopGroup

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

New-BrokerDesktopGroupWebhook

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

New-BrokerDesktopGroupWebhook

Syntax

Description

Examples

EXAMPLE 1

Parameters

-Address

-DesktopGroupUid

-OnEvent

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Broker.Admin.SDK.DesktopGroupWebhook

Outputs

None

Related Links

In this article