WorkflowAlert

Represents a workflow alert. A workflow alert is an email generated by a workflow rule or approval process and sent to designated recipients.

Version 

Introduced in API version 32.0.

Supported SOAP API Calls 

create(), delete(), query(), retrieve(), search(), update(), upsert()

Supported REST API Methods 

DELETE, GET, PATCH, POST

Fields 

CcEmails 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Additional CC email addresses.

Description 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: A description of the workflow alert.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The unique name of the workflow alert in the API.

EntityDefinitionId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The ID of the entity containing the alert.

FullName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• 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: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

Metadata 

• Type: WorkflowAlert

• Required: No

• Properties: Filter, Group, Nillable, Sort

• 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

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace of the package to uniquely identify the workflow alert.

SenderType 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The type of sender. Values are:

• CurrentUser

• OrgWideEmailAddress

• DefaultWorkflowUser

TemplateId 

• Type: ID

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: A reference to an email template.