--- schema_version: "1" id: 549613395480b15443428a62fb2e8474c60ee6c2814c1bd8a0b026a5a671a459 title: WorkflowAlert collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_workflowalert.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_workflowalert.htm source_site: developer.salesforce.com content_type: documentation content_hash: d87c17e22189810dc8597dea52468cfa795ae3c9b563ead093d68825a00b8fd9 description: Represents a workflow alert. A workflow alert is an email generated by a workflow rule or approval process and sent to designated recipients. --- # WorkflowAlert Represents a workflow alert. A workflow alert is an email generated by a workflow rule or approval process and sent to designated recipients. This object is available in API version 32.0 and later. ## Supported SOAP Calls create(), delete(), query(), retrieve(), search(), update(), upsert() ## Supported REST HTTP Methods DELETE, GET, PATCH, POST ## Fields | Field | Details | | --- | --- | | CcEmails | Type string Properties Filter, Nillable, Sort Description Additional CC email addresses. | | Description | Type string Properties Filter, Group, idLookup, Sort Description A description of the workflow alert. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique name of the workflow alert in the API. | | EntityDefinition | Type [EntityDefinition](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_entitydefinition.htm "Provides row-based access to metadata about standard and custom objects.") Properties Filter, Group, Sort. Description Required. Available in version 34.0. The entity definition for the object associated with this WebLink. | | EntityDefinitionId | Type string Properties Filter, Group, Sort Description The ID of the entity containing the alert. | | FullName | Type string Properties Create, Group, Nillable Description The full name of the associated metadata object in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. | | ManageableState | Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: - beta - deleted - deprecated - deprecatedEditable - installed - installedEditable - released - unmanaged | | Metadata | Type mns:WorkflowAlert Properties Create, Nillable, Update Description Alert definition metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. | | NamespacePrefix | Type string Properties Filter, Group, Sort Description The namespace of the package to uniquely identify the workflow alert. | | SenderType | Type ActionEmailSenderType enumerated list Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of sender. Values are: - CurrentUser - OrgWideEmailAddress - DefaultWorkflowUser | | TemplateId | Type ID Properties Filter, Group, Sort Description A reference to an email template. |