The createAlertFromPackageTemplate() GraphQL mutation field may be used to create an alert from a package alert template.

This mutation is no longer used internally and will be removed in a future release. Contact support if you are using this and cannot use createAlert() as a replacement.

For more information on creating alerts, see the Creating Alerts documentation page. You may also want to look at the Alerts and the Packages pages for related information.

Syntax

Below is the syntax for the createAlertFromPackageTemplate() mutation field:

graphql
createAlertFromPackageTemplate(
      searchDomainName: string!
      packageId: VersionedPackageSpecifier!
      alertTemplateName: string!
      alertName: string!
   ): CreateAlertFromPackageTemplateMutation!

Given and Returned Datatypes

The given datatype VersionedPackageSpecifier is just a scalar. The returned datatype CreateAlertFromPackageTemplateMutation has its own parameter:

Table: CreateAlertFromPackageTemplateMutation

ParameterTypeRequired[a]DefaultDescription
alertAlertyes The alert to create from the package template (see Alert Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.