Request HSM Template

Category: Variable manipulation

Description:
Allows sending structured messages (HSM) via WhatsApp using templates previously registered and approved by the provider (e.g., Gupshup). It is designed to facilitate communication with customers by incorporating dynamic parameters and allowing response storage when interaction is expected.

Functionality:
Triggers a request for a List-type entity from the client. The request form is enriched with additional values to enhance its appearance. Pauses Lynn's control flow until the user provides the required value.

Name: Text field to enter the name that will identify the element within the flow.

Entity where the customer's response is stored: Select field to choose the entity where the customer's response to the WhatsApp message will be saved.

Important

This field is only required if a response is expected from the customer. In that case, the reaction message will be stored in the entity selected in the Entity where the customer's response is stored field. Therefore, the flow will wait for this response to store its value in the corresponding entity.

Unique template identifier: Text field to enter the ID of the template. This value is available in the interface of the provider where the template was created.

Message preview: String field to enter a preview of the message, also available in the provider's interface, including the placeholders for dynamic parameters.

Template header: String expression field to enter the header of the template, required when using multimedia templates.

According to Gupshup documentation:

Key	Type	Description	Sample
message	object	Required only if the template is of type multimedia (Image, Video, Document .pdf, or Location).	Image: {"type":"image","image":{"link":""}} Video: {"type":"video","video":{"link":""}} Document: {"type":"document","document":{"link":""}} Location: {"type":"location","location":{"longitude":"","latitude":""}}

Tip

For example, for a multimedia template of type Image, the following value should be entered in the Template header field:
{"type":"image","image":{"link":"--image link--"}}

Dynamic parameters used in the template: Select field to specify the entities that will be used to fill in the dynamic fields of the HSM template.

Intent to execute in case of error (error details will be stored in a variable called RequestHSMTemplate_Error): Select field to define the intent that will be executed if an error occurs during the flow associated with this action. The error information will be stored in the RequestHSMTemplate_Error entity.