Email API

Was this helpful?

Using Inclivio's email API, you can email participants, yourself, and your research team from inside your survey flow. Email participants a custom progress report after completing their survey, your research coordinator when a participant has completed their final ecological momentary assessment, a clinician when a participant reports elevated distress and requires safety evalution, or any other notification that you can dream up. Emails sent from Inclivio's email API are sent free of charge.

On this page you will find information about:

Send Emails via Inclivio API

Inclivio allows you to send emails to your participants programmatically via our API. This is useful if you want to trigger emails based on events in your survey platform (e.g., sending a confirmation email after a survey is completed).

The endpoint for sending emails is: https://incliv.io/surveySendEmail

You must send a POST request with the following parameters in the body:

  • api-key: Your project's API Key (found in Project Settings).
  • pingid: The unique ID of the ping (the pingidsurvey parameter).
  • email-subject: The subject line of the email you wish to send
  • email-body: The body content of the email (text only).
  • email-recipients: A comma-separated list of email addresses (optional, defaults to participant's email).

Setting up Email API in Qualtrics

You can use the Qualtrics "Web Service" feature to trigger emails from Inclivio.

  1. In your Survey Flow, add a new Web Service element.

    Add Web Service

  2. Configure the request:

    • URL:https://incliv.io/surveySendEmail
    • Method: POST
    Web Service

  3. Select Add a body parameter to send to web service

    Web Service Add Body

  4. Set the parameter as pingid and the value as ${e:Field/pingid} (this is equivalent to Insert Piped Text > Embedded Data Field > pingid).

    Ping ID

  5. Add a second parameter using the button. Set the parameter as api-key and enter your project's API key. To find your project's API key in Inclivio, navigate to Project > Settings > Project API Key. Make sure only to share this key with people you trust.

    API Key

  6. Add another parameter called email-recipients and set the value as a comma-separated list of the individuals you wish you email. To email the participant, use the keyword participant. Only the participant and other verified users of Inclivio may be emailed. Emails are sent separtely (i.e., recipients are not CC'ed on the same email). For example, the following will email the participant and 'name@example.com': email-recipients = participant, name@example.com

    Email Recipients

  7. Add a parameter called email-subject, the value of which will be the subject line of your email.

    Email Subject

  8. Add a parameter called email-body, the value of which will be the body of your email. This field is text-only (no images HTML, JavaScript, or other computer code can be included).

    Email Body

Inclivio's Email API Policy

Users of Inclivio's email API must abide by the following rules.

  • Email recipients must provide affirmative consent to be contacted via email
  • Emails must not serve as additional pings
  • Inclivio prohibits sending content that is illegal, harmful toward others, unwanted, inappropriate, objectionable, confirmed to be criminal misinformation, or otherwise poses a threat to the public, even if the content is permissible by law. This type of content is not allowed, regardless of user consent. Examples of prohibited content include, but are not limited to:
    • Pornography or sexually explicity content
    • Statements about products claiming to prevent, treat, or cure health issues that have not been approved by appropriate government authorities or are not permitted under applicable law or regulation
    • Content that is fraudulent or that Inclivio determines in good faith is intended to mislead a recipient (e.g., phishing emails) or cause harm or damage (e.g., malware or viruses).
Was this helpful?