Set cloud app template properties

As you design your template in the Properties tab of the Cloud App Studio, you can customize essential details to ensure they align with your campaign needs. Here, you can:

• Edit the template name to make it clear and identifiable.
• Organize your template using tags or tag folders for easy categorization and retrieval.
• Configure advanced settings to tailor the template’s behavior.

Additionally, the Properties tab is where you define the key technical details, such as:

• Specifying the API endpoint for sending the message.
• Selecting the adapter that facilitates communication with the desired platform.

This tab is the foundation for effectively setting up and organizing your Cloud App template.

Configure the adaptor

Under the Settings section:

• Select an adapter: Use the dropdown menu under the Adapter field to choose the platform (e.g., WhatsApp) the template will connect to.
• Enter the API Endpoint: In the API Endpoint field, input the URL for the platform's API where the messages will be sent.

Organize with tags

Organize your cloud app templates by adding tags to your templates.

• Click + Add tag folder in the Tags section.
• Assign relevant tags to organize your template for easy access and categorization.

Define campaign behavior

In the Campaign Behavior section, select the checkboxes to define rules for message delivery:

• Do not message the user if any of the recommendation block(s) is empty - to prevent messages if recommendation blocks are empty.
• Do not message the user if the external fetch encounters an error or does not return any data - to avoid sending messages if external data fetch encounters errors or no data is available.
• Do not message the user if any of the products in the event is not available in the catalogs - to block messages if products in the event are unavailable in the catalog.

All three behaviors (checkboxes) are selected by default.

Advanced settings

The Advanced Settings section in the Properties tab lets you configure key technical details for your Cloud App template.

Add or modify HTTP headers

You can customize the HTTP headers for the API request by clicking +HTTP Header and adding key-value pairs as needed.

Important note - The following default headers are automatically applied to every request, but they are not displayed in the template:

• User-Agent: Blueshift Webhook 1.0
• Content-Type: application/json
• Accept: application/json

While these default headers cannot be removed, you can override their values by manually adding the corresponding key-value pairs. You can also include additional headers if required by your use case.

Configure the Unique Sent Identifier

Select a value from the Unique Sent Identifier dropdown to prevent sending duplicate messages to the same user.

Use an explicit identifier based on the type of messages being sent:

• For emails: Set it to email.
• For text messages: Set it as the phone number.
• If no specific field applies: Use customer_id to ensure a user is only messaged once, even if they appear multiple times in the database.

For example, if you send an NPS survey via email and the identifier is set to email, users with the same email address will receive only one message. Without this configuration, the same email address might receive duplicate messages.

Set the HTTP method

Choose the HTTP method used for the API call from the dropdown. The supported methods are:

• POST (default for custom apps)
• GET
• PUT
• PATCH

Send payload as URL encoded form

The Send payload as a URL encoded form checkbox is unselected by default. The payload is sent as a JSON object, with the Content-Type header set to application/json.

If you want to send the payload as a URL-encoded string (with the header set to application/x-www-form-urlencoded), select this checkbox.

Summary of use cases for advanced settings

• Prevent spam: Use the Unique Sent Identifier to avoid duplicate messages to the same user.
• Customize API requests: Modify or add HTTP headers to meet your third-party app requirements.
• Adjust HTTP method: Ensure the correct method (e.g., POST, GET) is used for API calls.
• Change payload format: Use the URL encoding option if required by the API you’re working with.

These configurations allow you to tailor your Cloud App template for specific technical and campaign needs.