netlify-build-plugin-dareboost
Advanced tools
Comparing version 1.0.1 to 1.0.2
{ | ||
"name": "netlify-build-plugin-dareboost", | ||
"version": "1.0.1", | ||
"version": "1.0.2", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
# Dareboost Netlify Build Plugin | ||
When a build is successful, add a Dareboost event on the page and/or User Journey monitors you have defined, using the [Dareboost API](https://www.dareboost.com/en/documentation-api). | ||
When a build is successful, adds a Dareboost event on the page and/or User Journey monitors you have defined, using the [Dareboost API](https://www.dareboost.com/en/documentation-api). | ||
@@ -9,16 +9,15 @@ ## How to use? | ||
``` | ||
npm i netlify-build-plugin-dareboost | ||
``` | ||
``` | ||
npm i netlify-build-plugin-dareboost | ||
``` | ||
2. Add the plugin declaration to your netlify.toml configuration file. | ||
``` | ||
[[plugins]] | ||
package = "netlify-build-plugin-dareboost" | ||
``` | ||
``` | ||
[[plugins]] | ||
package = "netlify-build-plugin-dareboost" | ||
``` | ||
1. Get your Dareboost API authentication token and save it in an environment variable called DAREBOOST_API_TOKEN (under **Settings > Build & deploy > Environment > Environment variables**).Please read [Netlify's documentation about environment variables](https://docs.netlify.com/configure-builds/environment-variables/). Your API token must be kept private. | ||
3. Get your Dareboost API authentication token and save it in an environment variable called DAREBOOST_API_TOKEN (under **Settings > Build & deploy > Environment > Environment variables**). Please read [Netlify's documentation about environment variables](https://docs.netlify.com/configure-builds/environment-variables/). Your API token must be kept **private**. | ||
### \[Optional\] Specify monitors | ||
@@ -28,4 +27,4 @@ | ||
- monitoringIds: The ids of the page monitors relevant to the build, separated by a coma. | ||
- scenarioIds: The ids of the User Journey monitors relevant to the build, separated by a coma. | ||
- `monitoringIds`: The ids of the page monitors relevant to the build, separated by a coma. | ||
- `scenarioIds`: The ids of the User Journey monitors relevant to the build, separated by a coma. | ||
@@ -32,0 +31,0 @@ Example: |
4228
40