Notifications

Test a notification

Performs a REAL delivery of the latest mention(s) matching the notification’s feed filters (one by default, up to three with limit) to every configured destination (email is actually sent, Slack message actually posted, webhook actually called) and returns a per-destination outcome plus the delivered mentions. Watermarks and delivery logs are untouched, so scheduled deliveries are unaffected. Returns NO_SAMPLE_MENTION (400) when no mention matches the feed’s filters yet.

POST

api

notifications

{id}

test

Test a notification

curl --request POST \
  --url https://app.octolens.com/api/v2/notifications/{id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 3
}'

import requests

url = "https://app.octolens.com/api/v2/notifications/{id}/test"

payload = { "limit": 3 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({limit: 3})
};

fetch('https://app.octolens.com/api/v2/notifications/{id}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.octolens.com/api/v2/notifications/{id}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'limit' => 3
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.octolens.com/api/v2/notifications/{id}/test"

	payload := strings.NewReader("{\n  \"limit\": 3\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.octolens.com/api/v2/notifications/{id}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"limit\": 3\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/notifications/{id}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"limit\": 3\n}"

response = http.request(request)
puts response.read_body

{
  "notificationId": 0,
  "results": [
    {
      "type": "EMAIL",
      "target": "<string>",
      "ok": true,
      "status": 0,
      "error": "<string>"
    }
  ],
  "mentions": [
    {
      "id": 0,
      "source": "reddit",
      "title": "<string>",
      "body": "<string>",
      "url": "<string>",
      "author": "<string>",
      "timestamp": "<string>"
    }
  ]
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

Authorizations

Authorization

string

header

required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Path Parameters

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

Body

application/json

Optional body of a test delivery. An empty body delivers one mention.

limit

integer

How many of the feed's latest matching mentions to deliver to each destination (1–3, default 1).

Required range: 1 <= x <= 3

Example:

3

Response

200 response

Per-destination outcomes of a real test delivery of the latest matching mention(s).

notificationId

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

results

object[]

required

One entry per configured destination, in stored order.

Show child attributes

mentions

object[]

required

The mentions that were delivered, newest first — the same set for every destination.

Show child attributes

Test a notification

curl --request POST \
  --url https://app.octolens.com/api/v2/notifications/{id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 3
}'

import requests

url = "https://app.octolens.com/api/v2/notifications/{id}/test"

payload = { "limit": 3 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({limit: 3})
};

fetch('https://app.octolens.com/api/v2/notifications/{id}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.octolens.com/api/v2/notifications/{id}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'limit' => 3
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.octolens.com/api/v2/notifications/{id}/test"

	payload := strings.NewReader("{\n  \"limit\": 3\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.octolens.com/api/v2/notifications/{id}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"limit\": 3\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/notifications/{id}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"limit\": 3\n}"

response = http.request(request)
puts response.read_body

{
  "notificationId": 0,
  "results": [
    {
      "type": "EMAIL",
      "target": "<string>",
      "ok": true,
      "status": 0,
      "error": "<string>"
    }
  ],
  "mentions": [
    {
      "id": 0,
      "source": "reddit",
      "title": "<string>",
      "body": "<string>",
      "url": "<string>",
      "author": "<string>",
      "timestamp": "<string>"
    }
  ]
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}