Create Alert Config

POST https://api.podengine.ai/api/v1/alerts/alert-config

Create a new alert configuration to monitor podcasts for mentions of a person, company, or custom keyword.

Example request

curl -X POST "https://api.podengine.ai/api/v1/alerts/alert-config" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_TOKEN" \
  -d '{
  "alertName": "Example Alert",
  "alertType": "person",
  "value": "Jason Calacanis"
}'

const options = {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
  "alertName": "Example Alert",
  "alertType": "person",
  "value": "Jason Calacanis"
})
};

fetch("https://api.podengine.ai/api/v1/alerts/alert-config", options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

import requests

headers = {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.post("https://api.podengine.ai/api/v1/alerts/alert-config", headers=headers, json={
  "alertName": "Example Alert",
  "alertType": "person",
  "value": "Jason Calacanis"
})
print(response.json())

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "YOUR_API_TOKEN");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var json = @"{
  ""alertName"": ""Example Alert"",
  ""alertType"": ""person"",
  ""value"": ""Jason Calacanis""
}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.podengine.ai/api/v1/alerts/alert-config", content);
var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);

package main

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

func main() {
	jsonData := []byte(`{
  "alertName": "Example Alert",
  "alertType": "person",
  "value": "Jason Calacanis"
}`)
	body := bytes.NewBuffer(jsonData)
	req, _ := http.NewRequest("POST", "https://api.podengine.ai/api/v1/alerts/alert-config", body)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "YOUR_API_TOKEN")
	
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

import { PodEngine } from '@podengine/sdk';

const pe = new PodEngine({ apiKey: process.env.PODENGINE_API_KEY });

const data = await pe.alerts.createAlertConfig({
  alertName: 'Example Alert',
  alertType: 'person',
  value: 'Jason Calacanis',
});

console.log(data);

import os

from podengine import PodEngine

pe = PodEngine(api_key=os.environ["PODENGINE_API_KEY"])

data = pe.alerts.create_alert_config(
    alert_name="Example Alert",
    alert_type="person",
    value="Jason Calacanis",
)

print(data)

200

Example response

{
  "status": "OK",
  "data": {
    "createdAlertConfig": {
      "id": "string",
      "createdByUserId": "string",
      "teamId": "string",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z",
      "alertName": "string",
      "alertType": "person",
      "enabled": true,
      "alertSettings": {
        "type": "person",
        "value": "string",
        "trackGuestAppearances": true,
        "trackHostAppearances": true,
        "trackMentions": true,
        "genresToSkip": [
          "string"
        ],
        "genresToInclude": [
          "string"
        ],
        "otherSpellings": [
          "string"
        ],
        "otherEmails": [
          "name@example.com"
        ],
        "contextAwareQuestion": "string",
        "contextAwareDetails": {
          "what": "string",
          "relevantClues": "string",
          "commonFalsePositives": "string"
        },
        "filterAdvertisements": true,
        "filters": {
          "excludeAds": true,
          "requireSubject": true
        },
        "subjectNote": "string"
      },
      "emailSettings": {
        "frequency": "hourly"
      },
      "lastRunDate": "2026-01-15T09:30:00.000Z",
      "subjectNoteCheck": {
        "status": "passed",
        "missing": "string"
      }
    }
  }
}

Request

Request body

alertNamestringrequired

Display name for this alert.

alertTypeenumrequired

Whether to track a person, company, or custom keyword.

personcompanycustom-keyword

valuestringrequired

Name or keyword to monitor in podcast episodes and transcripts.

emailSettingsobject1 field

Email notification schedule; defaults to daily when omitted.

frequencyenumrequired

How often alert email notifications should be sent.

hourlydailyweekly

enabledboolean

Whether the alert is active; defaults to true.

generateAlternativeSpellingsboolean

Generate and add phonetic spelling variants to the terms monitored by this alert.

additionalAlertSettingsobject4 fields

Additional recipients, spelling variants, filters and "Who is this?" note for this alert.

otherEmailsarray of string

Additional email addresses to receive alert notifications.

otherSpellingsarray of string

Additional spellings to match alongside the primary name or keyword.

filtersobject2 fields

Which mentions this alert hides. Omit to use the defaults.

excludeAdsboolean

Hide mentions inside ad reads (sponsor reads and promos for other shows). Defaults to true.

requireSubjectboolean

Person and company alerts only: hide mentions that are about someone or something else with the same name. Defaults to on when the alert's "Who is this?" note (subjectNote) has passed the note check (subjectNoteCheck), and off when it has not.

subjectNotestringmax 200 characters

Person and company alerts only: who this is, e.g. "CEO of Acme". Helps tell them apart from others with the same name. Send an empty string to remove it.

Response

200 application/json

statusliteral: OKrequired

dataobjectrequired1 field

createdAlertConfigobjectrequired12 fields

idstringrequired

createdByUserIdstringrequired

teamIdstringrequired

createdAtdaterequired

updatedAtdaterequired

alertNamestringrequired

alertTypeenumrequired

personcompanycustom-keyword

enabledbooleanrequired

alertSettingsintersectionrequired

emailSettingsobjectrequired1 field

frequencyenumrequired

How often alert email notifications should be sent.

hourlydailyweekly

lastRunDatedaterequirednullable

subjectNoteCheckobjectnullable2 fields

Person and company alerts: the note check of the "Who is this?" note this alert uses. Null when there is no note.

statusenumrequired

passed: matches are checked for the right person or company. failed: see missing. pending: not checked yet.

passedfailedpending

missingstringrequirednullable

When the check failed, what the note needs to tell them apart, e.g. "Add their role or company."