Skip to content

New-CWMCallbackEntry.md

Latest commit

 

History

History
282 lines (220 loc) · 5.94 KB

New-CWMCallbackEntry.md

File metadata and controls

282 lines (220 loc) · 5.94 KB
external help file ConnectWiseManageAPI-help.xml
Module Name ConnectWiseManageAPI
online version
schema 2.0.0

New-CWMCallbackEntry

SYNOPSIS

This function will create a new callback entry.

SYNTAX

New-CWMCallbackEntry [[-id] <Int32>] [[-description] <String>] [-url] <String> [-objectId] <Int32>
 [-type] <String> [-level] <String> [[-memberId] <Int32>] [-payloadVersion <String>]
 [[-inactiveFlag] <Boolean>] [-isSoapCallbackFlag <Boolean>] [-isSelfSuppressedFlag <Boolean>]
 [[-_info] <Hashtable>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

ConnectWise Manage callbacks are payloads of information that are similar to webhooks. When a record is saved within ConnectWise Manage, a summarized payload is sent to a specified location.

EXAMPLES

EXAMPLE 1

New-CWMCallbackEntry -level 'board' -objectid 63 -type 'ticket' -url 'http://christaylor.codes/webhook?id='

Create a new callback for all tickets on service board 63.

EXAMPLE 2

New-CWMCallbackEntry -level 'Status' -objectid 72 -type 'ticket' -url 'http://christaylor.codes/webhook?id='

Create a new callback for all tickets in status 72.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-_info

Metadata

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-description

This is used to label the callback's usage.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

Don't use. The database record id of the callback, this is automatically assigned.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-inactiveFlag

Used to determine if the callback is active and sending requests.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-level

The type of object you want to trigger on ticket, contact, opportunity, etc. See associated table for all values.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-memberId

This is a read only value that shows who initially created the Callback.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-objectId

The ObjectId should be the Id of whatever record (level) you are subscribing to. This should be set to 1 when using a level of Owner.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-type

This is the specific type of record such as Company, Ticket, Contact, etc... See the associated table for all values.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-url

This is the URL ConnectWise Manage will send the GET payload to.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-isSelfSuppressedFlag

{{ Fill isSelfSuppressedFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isSoapCallbackFlag

{{ Fill isSoapCallbackFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-payloadVersion

{{ Fill payloadVersion Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

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

OUTPUTS

NOTES

Author: Chris Taylor Date: 6/27/2019

RELATED LINKS

https://marketplace.connectwise.com/docs/redoc/manage/system.html#tag/CallbackEntries/paths/1system1callbacks/post https://developer.connectwise.com/Products/Manage/Developer_Guide#Callbacks_(Webhooks)