zenloop Developer Hub

Welcome to the zenloop developer hub. You'll find comprehensive documentation to help you start working with zenloop as quickly as possible, as well as support if you get stuck. Happy looping!

Get Started    

Implementing metatags

Implementing metatags depends on the channel you are using:

As a general approach, metatags should take the following format:

"metatags": {
  "survey_question": "How likely are you to recommend %[question subject] to a friend or colleague?",
  "question_subject": "zenloop",
  "request_for_comment_all": "Tell us a bit more about why you chose %[score] as a score",
  "thank_you_note_all": "Thanks for your feedback!",
  "thank_you_link_text_all": "example text",
  "thank_you_link_url_all":  "https://www.example.com"
}

Or if you are looking to customise based on score (e.g. a different message for detractors vs promoters) - we have provided all of these options below:

Metatag validation

If adding metatags by score type (e.g. thank_you_note_promoter, thank_you_note_passive, thank_you_note_detractor) they will work only if 'Customise based on score' switch is enabled within the web interface (on the design step of the survey).

For thank_you_link_url and thank_you_link_note to work, you will also need to enable the 'Add a link' switch in the web interface.

"metatags": {
  "survey_question": "How likely are you to recommend %[question subject] to a friend or colleague?",
  "question_subject": "zenloop",
  "request_for_comment_promoter": "Tell us a bit more about why you chose %[score] as a score",
  "request_for_comment_passive": "Tell us a bit more about why you chose %[score] as a score",
  "request_for_comment_detractor": "Tell us a bit more about why you chose %[score] as a score",
  "thank_you_note_promoter": "Thanks for your feedback!",
  "thank_you_note_passive": "Thanks for your feedback!",
  "thank_you_note_detractor": "Thanks for your feedback!",
  "thank_you_link_text_promoter": "example text",
  "thank_you_link_text_passive": "example text",
  "thank_you_link_text_detractor": "example text",
  "thank_you_link_url_promoter": "https://www.example.com",
  "thank_you_link_url_passive": "https://www.example.com",
  "thank_you_link_url_detractor": "https://www.example.com"
}

API Example

Here is how metatags might look like when you are adding an external recipient using our API:

{
  "recipient": {
    "email": "recipient@test.com",
    "first_name": "test_first_name",
    "last_name": "test_last_name",
    "metatags": {
      "survey_question": "How likely are you to recommend %[question subject] to a friend or colleague?",
      "question_subject": "zenloop",
      "request_for_comment_all": "Tell us a bit more about why you chose %[score] as a score",
      "thank_you_note_all": "Thanks for your feedback!",
      "thank_you_link_text_all": "example text",
      "thank_you_link_url_all": "https://www.example.com"
    },
    "properties": [
      {
        "name": "country",
        "value": "germany"
      },
      {
        "name": "gender",
        "value": "male"
      }
    ]
  }
}

Implementing metatags


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.