Set-MonitorWebhookProfile
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>
-Platform <WebhookProfilePlatform>
-Type <WebhookProfileType>
-MethodType <WebhookMethodType>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
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, payload format, platform, type of call, and method type.
$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 -Platform Slack -Type Webhook -MethodType POST
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 |
-Platform
webhook platform type. Possible values are Slack MicrosoftTeams ServiceNow Others
| Type: | WebhookProfilePlatform |
| Accepted values: | Unknown, Slack, MicrosoftTeams, ServiceNow, Others |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Type
webhook call type. Possible values are Webhook Api
| Type: | WebhookProfileType |
| Accepted values: | Unknown, Webhook, Api |
| 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 |
-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
Indicates whether the webhook profile was updated successfully.
Notes
Ensure the Uid provided corresponds to an existing webhook profile.