First steps
User Data
- Responsive Email Editor Review
- Designing your email
- Creating Synchronized Modules
- Setting Up Responsive Email Design
- Setting Up Smart Containers
- Creating a Gmail Promotions Annotation
- Adding The Rollover Effect
- Adding Anchor Links
- Module Library
- Adding a Table to an Email
- Adding Custom Fonts
- Creating CTA Button
- Working with Images
- Creating Timer
- Using AI in the Email Editor
Omnichannel
- Setting Up Widgets for Your Site
- Widget Calling
- Setting Up Locations for the Widget Calling Rules
- Storing data from widgets to contact fields
- Using Annoyance Safeguard
- Actions After Form Submission
- Replacing Double Opt-In System Workflow
- Creating Pop-ups via Google Tag Manager or WordPress
- Sending Yespo Widget Events to Google Analytics
- Using A/B Tests for Widgets
- Collecting Contact Information Using Request Forms
Automation
- Building and Editing Workflows
- Configuring Workflow Start/Stop Conditions
- Start Block
- Popular Blocks
- Message Blocks
- Using One from Many Message Block
- Contact Blocks
- Conditions Blocks
- Other Blocks
- Message to Segment Blocks
- Time Blocks
- Advanced Workflow Block Parameters
- Setting Up Allowed Send Time
- Using Workflow Launch History
- Webhook Workflows
- Workflow Troubleshooting
- Double Opt-In
- Welcome Сampaign
- Welcome Series Segmented by Category
- Launching a Workflow After a Contact Import
- Regular Workflow for a Segment
- Birthday Campaign
- Linking Workflow to the Button
- Using Variables from Order in Workflow
- Collecting Order Feedback
- Customer Reactivation
- Sending Extra Campaigns
- Sending Reminders at the Time Specified by the User
- Sending Campaign to Those Who Did Not Open the Previous One
- Using A/B Tests In Workflows
Personalization
Analytics
- Email Campaign Report
- Web Push Campaign Report
- Viber Campaign Report
- Mobile Push Campaign Report
- App Inbox Campaign Report
- Telegram Campaign Report
- In-App Report
- Widget Report
- Triggered Campaign Report
- AMP Campaign Report
- SMS Campaign Report
- Multilingual Campaign Report
- Setting up UTM Tags
- Revenue from Campaigns
- Tracking Campaign Performance in Google Analytics 4
- Message Analytics
Multilanguage Campaigns
Events and Behaviour Tracking
Recommendations
API
Security and Compliance
Validating Event parameters
Events that are sent to Yespo must meet specific requirements. Otherwise, the workflows may not work, you may lose important data, etc.
The Yespo system allows you to validate events and provide immediate feedback if event parameters contain errors. Also, the system checks that event includes the required parameters.
Setting Required Event Parameters
Set required event parameters so the system accepts an event only if it meets the specified structure.
Steps to set up event’s structure validation:
1. Create a new event or edit an existing one (See Events to learn more about how to create events in Yespo).
2. Enable the Validate parameters slide button.
3. Click + Add parameter.
4. Enter the parameter name in the corresponding field and select the Required parameter checkbox if the parameter is required.
5. Add other parameters as necessary, then click Edit.
Validating Event Parameters
Validate event parameters and structure using Generate event API method. Indicate parameters in the params array.
If parameters do not meet the specified structure, you will get the 400 bad request error and the required event structure in the response.
Response example:
The event should have the following params: [
{
"name": "EmailAddress",
"required": true
},
{
"name": "Phone Number",
"required": false
},
{
"name": "Name",
"required": false
}
]
Event types with enabled parameter validation are marked with a check icon.
Event requirements
Body Params | Type |
Required/Optional |
Description | Requirements |
eventTypeKey | String | Required |
Event type ID key. If no such event type exists with such a key, a new one is created. |
1. All characters are allowed except < ; ’ \ / | " ` ' ^ ? ! , >
2. Max. length: 100 characters. |
keyValue | String | Optional | The key of the event, which determines its uniqueness. If you don't pass a keyValue in the event, it is automatically taken from the request's Params object with such a priority:
An event without one of these parameters or a passed keyValue value is not accepted. |
1. The key must contain a unique value for each contact (for example, email, phone number, external contact id, etc.).
2. All characters are allowed except < ; ’ \ / | " ` ' ^ ? ! , >
3. Max. length: 300 characters. |
params |
Array of objects |
Optional |
List of event parameters represented as an array of "key" - "value" pairs. The parameter keys are arbitrary. Used in campaigns and for creating dynamic content in messages. |
1. Params array may be empty: []
2. The value of the name parameter must be unique.
|
See API documentation for more information.