Create a notification

POST

api

notifications

curl --request POST \
  --url https://app.octolens.com/api/v2/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "feedId": 0,
  "destinations": [
    {
      "time": "09:00",
      "timezone": "UTC",
      "dayOfWeek": 3
    }
  ]
}
'

import requests

url = "https://app.octolens.com/api/v2/notifications"

payload = {
    "name": "<string>",
    "feedId": 0,
    "destinations": [
        {
            "time": "09:00",
            "timezone": "UTC",
            "dayOfWeek": 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({
    name: '<string>',
    feedId: 0,
    destinations: [{time: '09:00', timezone: 'UTC', dayOfWeek: 3}]
  })
};

fetch('https://app.octolens.com/api/v2/notifications', 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",
  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([
    'name' => '<string>',
    'feedId' => 0,
    'destinations' => [
        [
                'time' => '09:00',
                'timezone' => 'UTC',
                'dayOfWeek' => 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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"feedId\": 0,\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"feedId\": 0,\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"feedId\": 0,\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}"

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

{
  "id": 0,
  "name": "Competitor mentions — Slack",
  "enabled": true,
  "feedId": 0,
  "feedName": "<string>",
  "destinations": [
    {
      "type": "EMAIL",
      "frequency": "hourly",
      "deliveryMode": "batch",
      "time": "09:00",
      "timezone": "UTC",
      "dayOfWeek": 3,
      "emailDestination": {
        "emails": "alice@example.com, bob@example.com"
      },
      "slackDestination": {
        "channels": "<string>",
        "channelNamesMap": "<string>"
      },
      "webhookDestination": {
        "url": "https://example.com/webhook"
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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>.

Body

application/json

Create a notification for an existing feed. Slack destinations are validated against the workspace's Slack connection (channel IDs must resolve); webhook URLs must be public http(s) endpoints — a URL whose host is, or resolves to, a private, loopback, link-local or unique-local address is refused (WEBHOOK_URL_INVALID), and the same screen runs again at every delivery.

name

string

required

Notification display name. Max 191 characters, no control characters.

Required string length: 1 - 191

feedId

integer

required

ID of the feed whose filters drive this notification. A feed can have at most one notification.

Required range: -9007199254740991 <= x <= 9007199254740991

destinations

object[]

required

Delivery destinations — at least one, at most one per type (EMAIL / SLACK / WEBHOOK). Each entry must carry exactly the sub-object matching its type.

Minimum array length: 1

Show child attributes

Response

200 response

A delivery rule: mentions matching the linked feed's filters are sent to the configured destinations.

integer

required

Notification ID.

Required range: -9007199254740991 <= x <= 9007199254740991

name

string

required

Display name shown in the app and included in deliveries.

Example:

"Competitor mentions — Slack"

enabled

boolean

required

When false, the notification is paused and nothing is delivered.

feedId

integer

required

The feed whose filters determine which mentions trigger this notification.

Required range: -9007199254740991 <= x <= 9007199254740991

feedName

string | null

required

Display name of the linked feed.

destinations

object[]

required

Configured delivery destinations (at most one per type).

Show child attributes

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Create a notification

curl --request POST \
  --url https://app.octolens.com/api/v2/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "feedId": 0,
  "destinations": [
    {
      "time": "09:00",
      "timezone": "UTC",
      "dayOfWeek": 3
    }
  ]
}
'

import requests

url = "https://app.octolens.com/api/v2/notifications"

payload = {
    "name": "<string>",
    "feedId": 0,
    "destinations": [
        {
            "time": "09:00",
            "timezone": "UTC",
            "dayOfWeek": 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({
    name: '<string>',
    feedId: 0,
    destinations: [{time: '09:00', timezone: 'UTC', dayOfWeek: 3}]
  })
};

fetch('https://app.octolens.com/api/v2/notifications', 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",
  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([
    'name' => '<string>',
    'feedId' => 0,
    'destinations' => [
        [
                'time' => '09:00',
                'timezone' => 'UTC',
                'dayOfWeek' => 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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"feedId\": 0,\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"feedId\": 0,\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"feedId\": 0,\n  \"destinations\": [\n    {\n      \"time\": \"09:00\",\n      \"timezone\": \"UTC\",\n      \"dayOfWeek\": 3\n    }\n  ]\n}"

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

{
  "id": 0,
  "name": "Competitor mentions — Slack",
  "enabled": true,
  "feedId": 0,
  "feedName": "<string>",
  "destinations": [
    {
      "type": "EMAIL",
      "frequency": "hourly",
      "deliveryMode": "batch",
      "time": "09:00",
      "timezone": "UTC",
      "dayOfWeek": 3,
      "emailDestination": {
        "emails": "alice@example.com, bob@example.com"
      },
      "slackDestination": {
        "channels": "<string>",
        "channelNamesMap": "<string>"
      },
      "webhookDestination": {
        "url": "https://example.com/webhook"
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
  }
}