Public/Webhooks.ps1
|
<# .SYNOPSIS Get all ClickUp webhooks. .DESCRIPTION Get all ClickUp webhooks. .EXAMPLE PS C:\> Get-ClickUpWebhooks -TeamID 123 Get all ClickUp webhooks for team with ID "123". .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. Only webhooks that were created by the authenticated user will be returned on this endpoint. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/webhooks.html https://jsapi.apiary.io/apis/clickup20/reference/0/webhooks/get-webhooks.html #> function Get-ClickUpWebhooks { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [UInt64]$TeamID ) $Webhooks = Invoke-ClickUpAPIGet -Endpoint "team/$TeamID/webhook" Return $Webhooks.webhooks } <# .SYNOPSIS Create a new ClickUp webhook. .DESCRIPTION Create a new ClickUp webhook. You may filter the location of resources that get sent to a webhook by passing an optional space_id, folder_id, list_id, or task_id in the body of the request. Without specifying any events, all event types will be sent to the webhook. However, you can filter for specific actions by sending an events array. To subscribe to specific events, pass an array of events that you want to subscribe to, otherwise pass "*" to subscribe to everything. .EXAMPLE PS C:\> New-ClickUpWebhook -Endpoint 'https://www.example.com/webhook' Create a new ClickUp webhook that subscribes to all resources and events. Posts information to the URL "https://www.example.com/webhook". .EXAMPLE PS C:\> New-ClickUpWebhook -Endpoint 'https://www.example.com/webhook' -Events 'taskCreated','taskUpdated','taskDeleted' -FilterToTaskID 9hx Create a new ClickUp webhook that subscribes to task with ID "9hx" task creation, update, and deletion events. Posts information to the URL "https://www.example.com/webhook". .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. Only webhooks that were created by the authenticated user will be returned on this endpoint. You may filter the location of resources that get sent to a webhook by passing an optional space_id, folder_id, list_id, or task_id in the body of the request. Without specifying any events, all event types will be sent to the webhook. However, you can filter for specific actions by sending an events array. To subscribe to specific events, pass an array of events that you want to subscribe to, otherwise pass "*" to subscribe to everything. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/webhooks.html https://jsapi.apiary.io/apis/clickup20/reference/0/webhooks/create-webhook.html #> function New-ClickUpWebhook { param ( [Parameter(Mandatory = $True)] [string]$Endpoint, [Parameter()] [string[]]$Events = '*', [Parameter()] [UInt64]$FilterToSpaceID, [Parameter()] [UInt64]$FilterToFolderID, [Parameter()] [string]$FilterToListID, [Parameter()] [string]$FilterToTaskID ) $Body = @{ endpoint = $Endpoint events = $Events } if ($PSBoundParameters.ContainsKey('FilterToSpaceID')) { $Body.Add('space_id', $FilterToSpaceID) } if ($PSBoundParameters.ContainsKey('FilterToFolderID')) { $Body.Add('folder_id', $FilterToFolderID) } if ($PSBoundParameters.ContainsKey('FilterToListID')) { $Body.Add('list_id', $FilterToListID) } if ($PSBoundParameters.ContainsKey('FilterToTaskID')) { $Body.Add('task_id', $FilterToTaskID) } $Webhook = Invoke-ClickUpAPIPost -Endpoint "team/$TeamID/webhook" -Body $Body Return $Webhook } <# .SYNOPSIS Create a new ClickUp webhook. .DESCRIPTION Create a new ClickUp webhook. You may filter the location of resources that get sent to a webhook by passing an optional space_id, folder_id, list_id, or task_id in the body of the request. Without specifying any events, all event types will be sent to the webhook. However, you can filter for specific actions by sending an events array. To subscribe to specific events, pass an array of events that you want to subscribe to, otherwise pass "*" to subscribe to everything. .EXAMPLE PS C:\> Set-ClickUpWebhook -WebhookID 4b67ac88 -Endpoint 'https://www.example.com/webhook' Updates a ClickUp webhook with ID "4b67ac88" that subscribes to all resources and events. Posts information to the URL "https://www.example.com/webhook". .EXAMPLE PS C:\> Set-ClickUpWebhook -WebhookID 4b67ac88 -Endpoint 'https://www.example.com/webhook' -Events 'taskCreated','taskUpdated','taskDeleted' -FilterToTaskID 9hx Updates a ClickUp webhook with ID "4b67ac88" that subscribes to task with ID "9hx" task creation, update, and deletion events. Posts information to the URL "https://www.example.com/webhook". .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. Only webhooks that were created by the authenticated user will be returned on this endpoint. You may filter the location of resources that get sent to a webhook by passing an optional space_id, folder_id, list_id, or task_id in the body of the request. Without specifying any events, all event types will be sent to the webhook. However, you can filter for specific actions by sending an events array. To subscribe to specific events, pass an array of events that you want to subscribe to, otherwise pass "*" to subscribe to everything. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/webhooks.html https://jsapi.apiary.io/apis/clickup20/reference/0/webhooks/update-webhook.html #> function Set-ClickUpWebhook { param ( [Parameter(Mandatory = $True)] [string]$WebhookID, [Parameter()] [string]$Endpoint, [Parameter()] [string[]]$Events, [Parameter()] [ValidateSet('active')] [string]$Status, [Parameter()] [UInt64]$FilterToSpaceID, [Parameter()] [UInt64]$FilterToFolderID, [Parameter()] [string]$FilterToListID, [Parameter()] [string]$FilterToTaskID ) $Body = @{} if ($PSBoundParameters.ContainsKey('Endpoint')) { $Body.Add('endpoint', $Endpoint) } if ($PSBoundParameters.ContainsKey('Events')) { $Body.Add('events', $Events) } if ($PSBoundParameters.ContainsKey('Status')) { $Body.Add('status', $Status) } if ($PSBoundParameters.ContainsKey('FilterToSpaceID')) { $Body.Add('space_id', $FilterToSpaceID) } if ($PSBoundParameters.ContainsKey('FilterToFolderID')) { $Body.Add('folder_id', $FilterToFolderID) } if ($PSBoundParameters.ContainsKey('FilterToListID')) { $Body.Add('list_id', $FilterToListID) } if ($PSBoundParameters.ContainsKey('FilterToTaskID')) { $Body.Add('task_id', $FilterToTaskID) } $Webhook = Invoke-ClickUpAPIPut -Endpoint "webhook/$WebhookID" -Body $Body Return $Webhook } <# .SYNOPSIS Remove a ClickUp webhook. .DESCRIPTION Remove a ClickUp webhook. .EXAMPLE PS C:\> Remove-ClickUpWebhook -WebhookID 4b67ac88 Remove a ClickUp webhook with ID "4b67ac88". .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. Only webhooks that were created by the authenticated user will be returned on this endpoint. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/webhooks.html https://jsapi.apiary.io/apis/clickup20/reference/0/webhooks/delete-webhook.html #> function Remove-ClickUpWebhook { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] [string]$WebhookID ) if ($PSCmdlet.ShouldProcess($WebhookID)) { Invoke-ClickUpAPIDelete -Endpoint "webhook/$WebhookID" } } |