" %}
{% endtab %}
{% endtabs %}
| Argument | Type | Description |
|---|
| url | string | Required. The url of your watchers source. For example, a pages' Instagram profile URL. |
| webhookUrl | string | Optional. The url of your webhook that will recieve alerts. Use empty string to remove webhook. |
| filterPrompt | string | Optional. The prompt for the Ai use as filter criteria. Determines if you get alerted. Max 2000 chars. Use empty string to remove filter criteria. |
| alias | string | Optional. A human friendly name to identify your watcher. Max 256 chars. |
| autoExpireMs | number | Optional. Watchers can auto-expire if it hasn't seen any activity in milliseconds. Defaults to 3 months. Min 1 hour, Max 10 years. |
| note | string | Optional. A private note only you can see. Max 10k chars. |
| customData.uid | string | Optional. A string field indexed for you to use as a custom searchable ID (eg. your users). Max 256 chars. |
| customData.data | string | Optional. A string serialized object for any additional data you want to store. Max 100kb or 100k chars. |
***
***
### Update Watcher
{% hint style="info" %}
**POST /watchers/:watcherID/update**\
\
Update a Watcher with advanced features such as custom metadata & auto-expire after inactivity.
{% endhint %}
{% tabs %}
{% tab title="Request" %}
// copy paste this to your browser console to run
const API_KEY = 'YOUR_API_KEY'
const WATCHER_ID = 'WATCHER_ID'
const payload = {
status: "Paused",
webhookUrl: "https://yourapp.com/other-webhook",
filterPrompt: "Alert me if its a post about collapse of the Roman Empire",
note: "Still a private note",
alias: "A friendly title for your team",
autoExpireMs: 1000*60*60*24*30, // auto-pause after 30 days inactivity
customData: {
uid: "your-custom-unique-id",
data: JSON.stringify({ hello: 'world' })
}
}
fetch(`https://api.alerts.boo/v1/watchers/${WATCHER_ID}/update`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'api-key': API_KEY
},
body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => console.log(data));
.catch(error => console.log(error));
{% endtab %}
{% tab title="Response" %}
> [👉 View Sample Response](https://raw.githubusercontent.com/0xterran/samples-alertsboo/main/samples/updateWatcher.json)
```typescript
// Type Definition
interface ResponseBody {
trigger: Trigger, // Scroll up for Type Schema
}
```
{% endtab %}
{% tab title="Try It" %}
> Click "Run Pen" and "JS" button for the interactive code \
> Recommended to open in new tab (click Edit on Codepen)
{% embed url="" %}
{% endtab %}
{% endtabs %}
| Argument | Type | Description |
|---|
| status | enum | Optional. Set watcher status to Active or Paused or Inactive (Be careful with Inactive as it is equal to a deletion and cannot be undone). |
| webhookUrl | string | Optional. The url of your webhook that will recieve alerts. Use empty string to remove webhook. |
| filterPrompt | string | Optional. The prompt for the Ai use as filter criteria. Determines if you get alerted. Max 2000 chars. Use empty string to remove filter criteria. |
| note | string | Optional. A private note only you can see. Max 10k chars. |
| alias | string | Optional. A human friendly name to identify your watcher. Max 256 chars. |
| autoExpireMs | number | Optional. Watchers can auto-expire if it hasn't seen any activity in milliseconds. Defaults to 3 months. Min 1 hour, Max 10 years. |
| customData.uid | string | Optional. A string field indexed for you to use as a custom searchable ID (eg. your users). Max 256 chars. |
| customData.data | string | Optional. A string serialized object for any additional data you want to store. Max 100kb or 100k chars. |
***
### List Logs
{% hint style="info" %}
**POST /watchers/:watcherID/logs/list**\
\
List the most recents logs from a Watcher. Paginate through logs by most recent first.
{% endhint %}
{% tabs %}
{% tab title="Request" %}
```javascript
// copy paste this to your browser console to run
const API_KEY = 'YOUR_API_KEY'
const WATCHER_ID = 'WATCHER_ID'
const query = {
limit: 50, // always returned newest first
cursor: 'prev-watcher-id'
}
fetch(`https://api.alerts.boo/v1/watchers/${WATCHER_ID}/logs/list`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'api-key': API_KEY
}
body: JSON.stringify(query)
})
.then(response => response.json())
.then(data => console.log(data));
.catch(error => console.log(error));
```
{% endtab %}
{% tab title="Response" %}
> [👉 View Sample Response](https://raw.githubusercontent.com/0xterran/samples-alertsboo/main/samples/listLogs.json)
```typescript
// Type Definition
interface ResponseBody {
logs: Log[], // Scroll up for Type Schema
nextCursor: string, // LogID
count: number
}
```
{% endtab %}
{% tab title="Try It" %}
> Click "Run Pen" and "JS" button for the interactive code \
> Recommended to open in new tab (click Edit on Codepen)
{% embed url="" %}
{% endtab %}
{% endtabs %}
| Argument | Type | Description |
|---|
| limit | number | Optional. Limit the search results. Default is 20, max is 100 |
| cursor | LogID | Optional Pagination. The string ID of the last Log of your previous query. |
***
### Get Log
{% hint style="info" %}
**GET /logs/:logID**\
\
Get details of a specific log.
{% endhint %}
{% tabs %}
{% tab title="Request" %}
```javascript
// copy paste this to your browser console to run
const API_KEY = 'YOUR_API_KEY'
const logID = "YOUR_LOG_ID"
fetch(`https://api.alerts.boo/v1/logs/${logID}`, {
method: 'GET',
headers: {
'Content-Type': 'application/json',
'api-key': API_KEY
}
})
.then(response => response.json())
.then(data => console.log(data));
.catch(error => console.log(error));
```
{% endtab %}
{% tab title="Response" %}
> [👉 View Sample Response](https://raw.githubusercontent.com/0xterran/samples-alertsboo/main/samples/getLog.json)
```typescript
// Type Definition
interface ResponseBody {
log: Log, // Scroll up for Type Schema
}
```
{% endtab %}
{% tab title="Try It" %}
> Click "Run Pen" and "JS" button for the interactive code \
> Recommended to open in new tab (click Edit on Codepen)
{% embed url="" %}
{% endtab %}
{% endtabs %}
***
### My Profile
{% hint style="info" %}
**GET /users/:userID**\
\
Get user details of your account.
{% endhint %}
{% tabs %}
{% tab title="Request" %}
```javascript
// copy paste this to your browser console to run
const API_KEY = 'YOUR_API_KEY'
const userID = "YOUR_USER_ID"
fetch(`https://api.alerts.boo/v1/users/${userID}`, {
method: 'GET',
headers: {
'Content-Type': 'application/json',
'api-key': API_KEY
}
})
.then(response => response.json())
.then(data => console.log(data));
.catch(error => console.log(error));
```
{% endtab %}
{% tab title="Response" %}
> [👉 View Sample Response](https://raw.githubusercontent.com/0xterran/samples-alertsboo/main/samples/myProfile.json)
```typescript
// Type Definition
interface ResponseBody {
user: User, // Scroll up for Type Schema
}
```
{% endtab %}
{% tab title="Try It" %}
> Click "Run Pen" and "JS" button for the interactive code \
> Recommended to open in new tab (click Edit on Codepen)
{% embed url="" %}
{% endtab %}
{% endtabs %}
***
### Rotate API Key
{% hint style="info" %}
**POST /users/:userID/rotate-token**\
\
Rotate your accounts' API key and return the new key in response. Be careful as old keys will stop working.
{% endhint %}
{% tabs %}
{% tab title="Request" %}
```javascript
// copy paste this to your browser console to run
const API_KEY = 'YOUR_API_KEY'
const userID = "YOUR_USER_ID"
fetch(`https://api.alerts.boo/v1/users/${userID}/rotate-token`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'api-key': API_KEY
}
})
.then(response => response.json())
.then(data => console.log(data));
.catch(error => console.log(error));Request
```
{% endtab %}
{% tab title="Response" %}
> [👉 View Sample Response](https://raw.githubusercontent.com/0xterran/samples-alertsboo/main/samples/rotateAPIKey.json)
```typescript
// Type Definition
interface ResponseBody {
user: User, // Scroll up for Type Schema
}
```
{% endtab %}
{% tab title="Try It" %}
> Click "Run Pen" and "JS" button for the interactive code \
> Recommended to open in new tab (click Edit on Codepen)
{% embed url="" %}
{% endtab %}
{% endtabs %}
***
### Buy Credits
{% hint style="info" %}
**POST /billing/:userID/topup-credits**\
\
Buy additional credits to pay for your usage. You will first need to setup billing by entering your credit card in the webapp settings page 👉 \
\
Use this API route to programmatically buy more credits whenever you need. Your default credit card will be billed.
{% endhint %}
{% tabs %}
{% tab title="Request" %}
```javascript
// copy paste this to your browser console to run
const API_KEY = 'YOUR_API_KEY'
const userID = "YOUR_USER_ID"
const payload = {
amount: 1000
}
fetch(`https://api.alerts.boo/v1/billing/${userID}/topup-credits`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'api-key': API_KEY
},
body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => console.log(data));
.catch(error => console.log(error));
```
{% endtab %}
{% tab title="Response" %}
> [👉 View Sample Response](https://raw.githubusercontent.com/0xterran/samples-alertsboo/main/samples/buyCredits.json)
```typescript
// Type Definition
interface ResponseBody {
txID: string, // purchase reciept ID
creditsReceived: number,
pricePaid: number, // in USD eg. 5.00 = five dollars usd
currency: "USD", // always the same USD
cardCharged: string // last 4 digits of credit card on file
}
```
{% endtab %}
{% tab title="Try It" %}
> Click "Run Pen" and "JS" button for the interactive code \
> Recommended to open in new tab (click Edit on Codepen)
{% embed url="" %}
{% endtab %}
{% endtabs %}
| Argument | Type | Description |
|---|
| amount | number | Required. The amount of credits you would like to buy as a one-time purchase. Min 20 credits, Max 40k credits. |
***
### Rate Limits
There are 3 rate limits for the REST API. Contact us if you need more.
| Rate | Routes |
|---|
| 1 per 3 seconds | POST /billing/:userID/topup-credits
POST /users/:userID/rotate-token |
| 3 per 3 seconds | POST /watchers/list
POST /watchers/:watcherID/logs/list |
| 10 per 3 seconds | Everything Else |
