WebhookAction is a
datatype for a webhook action.
Table: WebhookAction
| Parameter | Type | Required | Default | Stability | Description |
|---|---|---|---|---|---|
| Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
| Table last updated: Apr 2, 2025 | |||||
allowedActions | [AssetAction] | yes | Preview | A list of allowed asset actions. See AssetAction. This is a preview and subject to change. | |
bodyTemplate | string | yes | Long-Term | Body of the http and https request. Can be templated with values from the result. | |
displayName | string | yes | Long-Term | The display name of the action. | |
headers | [HttpHeaderEntry] | yes | Long-Term | Headers of the http and https requests. See HttpHeaderEntry. | |
id | string | yes | Long-Term | The unique identifier of the action. | |
ignoreSSL | boolean | yes | Long-Term | Whether SSL should be ignored for the request. | |
isAllowedToRun | boolean | yes | Long-Term | Set to false to disable this type of action for security reasons. | |
method | string | yes | Long-Term | Method to use for the request. | |
name | string | yes | Long-Term | The name of the action. | |
package | PackageInstallation | yes | Long-Term | The package, if there is one, of which the action is part. See PackageInstallation. | |
packageId | VersionedPackageSpecifier | Long-Term | The unique identifier of the package. See VersionedPackageSpecifier. | ||
requiresOrganizationOwnedQueriesPermissionToEdit | boolean | yes | Long-Term | This should be set to true if this action is used by triggers, where the query is run by the organization. If true, then the OrganizationOwnedQueries permission is required to edit the action. See Permission. | |
resource | string | yes | Short-Term | The resource identifier for the action. | |
url | string | yes | Long-Term | The URL where to send http and https requests. | |
useProxy | boolean | yes | Long-Term | Whether the action should use the configured proxy to make web requests. | |
yamlTemplate | yaml | yes | Long-Term | A template that can be used to recreate the action. | |