Add-MonitorWebhookProfile
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>
-Platform <WebhookProfilePlatform>
-Type <WebhookProfileType>
-MethodType <WebhookMethodType>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
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, 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"
Add-MonitorWebhookProfile -Name "webhookprofile1" -Description "Description" -Url $url -Headers $headers -PayloadFormat $payloads -Platform Slack -Type Webhook -MethodType POST
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 |
-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 created successfully. Returns true if successful; otherwise, false.