WebhookAction is a datatype for a webhook action.

Table: WebhookAction

ParameterTypeRequiredDefaultStabilityDescription
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: Oct 7, 2024
allowedActions[AssetAction]yes  A list of allowed asset actions. See AssetAction. This is a preview and subject to change.
bodyTemplatestringyes  Body of the http and https request. Can be templated with values from the result.
displayNamestringyes  The display name of the action.
headers[HttpHeaderEntry]yes  Headers of the http and https requests. See HttpHeaderEntry.
idstringyes  The unique identifier of the action.
ignoreSSLbooleanyes  Whether SSL should be ignored for the request.
methodstringyes  Method to use for the request.
namestringyes  The name of the action.
packagePackageInstallationyes  The package, if there is one, of which the action is part. See PackageInstallation.
packageIdVersionedPackageSpecifier   The unique identifier of the package. See VersionedPackageSpecifier.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes  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.
urlstringyes  The URL where to send http and https requests.
useProxybooleanyes  Whether the action should use the configured proxy to make web requests.
webhookactionbooleanyes  Whether the action is allowed to run. Should be false if this type of action is disabled because of a security policy.
yamlTemplateYAMLyes  A template that can be used to recreate the action.