New-FilesWebhookTest

Create Webhook Test.

Syntax

New-FilesWebhookTest -Url <System.String> [-Method <System.String>] [-Encoding <System.String>] [-Headers <System.Collections.IDictionary>] [-Body <System.Collections.IDictionary>] [-RawBody <System.String>] [-FileAsBody <System.Boolean>] [-FileFormField <System.String>] [-Action <System.String>] [-UseDedicatedIps <System.Boolean>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Create Webhook Test.

The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.

Examples

Example 1: Create Webhook Test

New-FilesWebhookTest -Url 'https://www.site.com/...' -Method 'GET' -Encoding 'RAW'

Writes the webhook test returned.

Example 2: Preview the change

New-FilesWebhookTest -Url 'https://www.site.com/...' -Method 'GET' -Encoding 'RAW' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Url

URL for testing the webhook.

  • Type: System.String
  • Parameter sets: (All) (required)

-Method

HTTP method(GET or POST).

  • Type: System.String
  • Parameter sets: (All)

-Encoding

HTTP encoding method. Can be JSON, XML, or RAW (form data).

  • Type: System.String
  • Parameter sets: (All)

-Headers

Additional request headers. Give a hashtable or PSCustomObject; keys keep their case and values their types.

  • Type: System.Collections.IDictionary
  • Parameter sets: (All)

-Body

Additional body parameters. Give a hashtable or PSCustomObject; keys keep their case and values their types.

  • Type: System.Collections.IDictionary
  • Parameter sets: (All)

-RawBody

raw body text

  • Type: System.String
  • Parameter sets: (All)

-FileAsBody

Send the file data as the request body?

  • Type: System.Boolean
  • Parameter sets: (All)

-FileFormField

Send the file data as a named parameter in the request POST body

  • Type: System.String
  • Parameter sets: (All)

-Action

action for test body

  • Type: System.String
  • Parameter sets: (All)

-UseDedicatedIps

Use dedicated IPs for sending the webhook?

  • Type: System.Boolean
  • Parameter sets: (All)

-Connection

The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.

  • Type: FilesCom.PowerShell.FilesConnection
  • Parameter sets: (All)

-WorkspaceScope

Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.

  • Type: System.Int64
  • Parameter sets: (All)

-NoWorkspaceScope

Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.

  • Type: System.Management.Automation.SwitchParameter
  • Parameter sets: (All)

-Confirm

Prompts you for confirmation before running the cmdlet.

  • Type: System.Management.Automation.SwitchParameter
  • Confirm impact: Medium. At the default $ConfirmPreference of High, the command runs without asking; -Confirm makes it ask before each change.

-WhatIf

Shows what the cmdlet would change without sending anything to Files.com.

  • Type: System.Management.Automation.SwitchParameter

Common Parameters

This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.

Inputs

None. The command takes no pipeline input.

Outputs

  • FilesCom.PowerShell.Models.WebhookTest: the webhook test as Files.com returned it.

Notes

Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.