feedbackspark/README.md

Simple in-product surveys for SaaS product teams. Get contextual feedback from the right users with precise targeting.

<p align="center">
 <a href="https://feedbackspark.com/">
 <img src="https://cdn.feedbackspark.com/fs-short-logo.png" alt="FeedbackSpark logo" width="200">
 </a>
</p>

<h3 align="center">FeedbackSpark</h3>

<p align="center">
  Simple in-product surveys for SaaS product teams. Get contextual feedback from the right users with precise targeting.
  <br>
  <a href="https://feedbackspark.com/blog/">Blog</a>
</p>

## Install with NPM/Yarn

Use the following command to install FeedbackSpark in your javascript apps.

```js
npm install --save feedbackspark
```

## Usage

```js
import spark from feedbackspark;
spark("init", API_TOKEN);
```

## APIs

### Set User (Recommended)

```js
spark("setUser", USER_ID);
```

### Logout User

Do not forget to log out user from FeedbackSpark when they log out from your application. This is to avoid assigning their user id to some other user.

```js
spark("logoutUser");
```

### Manually trigger a specific survey

```js
spark("showSurvey", SURVEY_CODE);
```

Look for survey code in the survey creation page.

<a href="https://feedbackspark.com/docs/"><span>Explore FeedbackSpark docs »</span></a>