API reference

List projects

GET /api/v1/projects

list_projects Read MCP tool

Every project (a brand or topic you monitor) in the workspace.

Any API key or OAuth token, or a signed-in member.

Example

curl "https://sniffington.com/api/v1/projects" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Create a project

POST /api/v1/projects

create_project Write MCP tool

Creates a project with 'My brand' and 'Competitors' keyword groups and the default categories. Pass keywords/competitors to start searching right away.

A full-access key (ss_sk_…), or an editor or owner signed in.

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X POST "https://sniffington.com/api/v1/projects" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme"}'

Get a project

GET /api/v1/projects/{project}

get_project Read MCP tool

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/projects/{project}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Update a project

PATCH /api/v1/projects/{project}

update_project Write MCP tool

Change settings, sources, cadence, pause/resume, or publish a public dashboard (public: true).

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X PATCH "https://sniffington.com/api/v1/projects/{project}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme","mode":"mentions"}'

Delete a project

DELETE /api/v1/projects/{project}

delete_project Write MCP tool

Stops scanning and hides the project. Its mentions are kept privately unless purge=true.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X DELETE "https://sniffington.com/api/v1/projects/{project}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Scan a project now

POST /api/v1/projects/{project}/scan

scan_project Write MCP tool

Queues an immediate scan. Results arrive as mentions (and mention.created webhooks).

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X POST "https://sniffington.com/api/v1/projects/{project}/scan" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

List keyword groups

GET /api/v1/projects/{project}/groups

list_keyword_groups Read MCP tool

Every project has 'My brand' and 'Competitors'; add custom ones for products, people or topics.

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/projects/{project}/groups" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Create a keyword group

POST /api/v1/projects/{project}/groups

create_keyword_group Write MCP tool

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X POST "https://sniffington.com/api/v1/projects/{project}/groups" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme"}'

Update a keyword group

PATCH /api/v1/groups/{group}

update_keyword_group Write MCP tool

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X PATCH "https://sniffington.com/api/v1/groups/{group}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme","kind":"brand"}'

Delete a keyword group

DELETE /api/v1/groups/{group}

delete_keyword_group Write MCP tool

Its keywords stay, ungrouped.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X DELETE "https://sniffington.com/api/v1/groups/{group}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

List keywords

GET /api/v1/projects/{project}/keywords

list_keywords Read MCP tool

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/projects/{project}/keywords" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Add a keyword

POST /api/v1/projects/{project}/keywords

create_keyword Write MCP tool

Aliases catch other spellings, handles and domains; excluded terms skip posts that also contain them.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X POST "https://sniffington.com/api/v1/projects/{project}/keywords" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"term":"acme"}'

Get a keyword

GET /api/v1/keywords/{keyword}

get_keyword Read MCP tool

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/keywords/{keyword}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Update a keyword

PATCH /api/v1/keywords/{keyword}

update_keyword Write MCP tool

Set active:false to stop searching it while keeping its mentions.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X PATCH "https://sniffington.com/api/v1/keywords/{keyword}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"term":"acme","aliases":["acme.com"]}'

Delete a keyword

DELETE /api/v1/keywords/{keyword}

delete_keyword Write MCP tool

Mentions it found are kept.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X DELETE "https://sniffington.com/api/v1/keywords/{keyword}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

List categories

GET /api/v1/projects/{project}/categories

list_categories Read MCP tool

The AI files every relevant mention into one of these.

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/projects/{project}/categories" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Create a category

POST /api/v1/projects/{project}/categories

create_category Write MCP tool

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X POST "https://sniffington.com/api/v1/projects/{project}/categories" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme"}'

Update a category

PATCH /api/v1/categories/{category}

update_category Write MCP tool

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X PATCH "https://sniffington.com/api/v1/categories/{category}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme","description":"Invoicing software for plumbers."}'

Delete a category

DELETE /api/v1/categories/{category}

delete_category Write MCP tool

Mentions in it become uncategorised.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X DELETE "https://sniffington.com/api/v1/categories/{category}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

List mentions

GET /api/v1/mentions

list_mentions Read MCP tool

Filter, search and page through mentions. Cursor-paginated: pass next_cursor back as cursor.

Any API key or OAuth token, or a signed-in member.

Parameters

Returns

{ data: Mention[], next_cursor, total }

Example

curl "https://sniffington.com/api/v1/mentions" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Today's brief

GET /api/v1/brief

get_brief Read MCP tool

What needs a person today: open mentions ranked by urgency, each with the AI's one-line reason, how many are open per project and how many arrived in the last 24 hours. Start here when asked what people are saying about a brand.

Any API key or OAuth token, or a signed-in member.

Parameters

Returns

{ data: { open, new_24h, projects: [{ id, name, open }], mentions: Mention[] } }

Example

curl "https://sniffington.com/api/v1/brief" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Change the status of many mentions

POST /api/v1/mentions/bulk

bulk_update_mentions Write MCP tool

Sets the status of every mention matching the filters (the list_mentions query parameters), or of the given ids. Useful for clearing an old backlog, e.g. status=done with status filter open and until=90 days ago.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X POST "https://sniffington.com/api/v1/mentions/bulk" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"done"}'

Get a mention

GET /api/v1/mentions/{mention}

get_mention Read MCP tool

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/mentions/{mention}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Update a mention

PATCH /api/v1/mentions/{mention}

update_mention Write MCP tool

Set status (open, done, follow_up), or correct the AI's category, sentiment, urgency or relevance.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X PATCH "https://sniffington.com/api/v1/mentions/{mention}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"done","category_id":1}'

Mark a mention irrelevant

POST /api/v1/mentions/{mention}/irrelevant

mark_mention_irrelevant Write MCP tool

Moves it out of the feed for good (it will never be re-collected). The reason teaches the AI what to skip next time.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X POST "https://sniffington.com/api/v1/mentions/{mention}/irrelevant" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"About a different Acme"}'

Delete a mention

DELETE /api/v1/mentions/{mention}

delete_mention Write MCP tool

Removes it from every view. It stays remembered so it's never collected again.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X DELETE "https://sniffington.com/api/v1/mentions/{mention}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Draft a reply

POST /api/v1/mentions/{mention}/draft

draft_reply Write

Writes a short, help-first reply in the post's own register. Nothing is posted; you copy it.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X POST "https://sniffington.com/api/v1/mentions/{mention}/draft" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

List authors

GET /api/v1/authors

list_authors Read MCP tool

mode=all for autocomplete (with q), supporters for the most positive, critics for the most negative.

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/authors" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Mention analytics

GET /api/v1/analytics

get_analytics Read MCP tool

Totals, mentions over time with the sentiment split, and the mix by source, category, keyword and group, plus the weekday × hour heatmap and top supporters and critics – one call.

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/analytics" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Break mentions down by one dimension

GET /api/v1/analytics/breakdown

get_breakdown Read MCP tool

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/analytics/breakdown" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Mentions per day by source, project, sentiment, category or group

GET /api/v1/analytics/volume

get_volume Read MCP tool

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/analytics/volume" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Run a read-only SQL query

POST /api/v1/analytics/sql

query_sql Read MCP tool

SELECT/WITH over the workspace's tables (mentions, projects, keywords, categories, keyword_groups, runs). Capped at 1,000 rows.

Any API key or OAuth token, or a signed-in member.

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X POST "https://sniffington.com/api/v1/analytics/sql" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sql":"SELECT source, COUNT(*) AS n FROM mentions GROUP BY source"}'

List saved views

GET /api/v1/views

list_views Read MCP tool

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/views" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Save a view

POST /api/v1/views

create_view Write MCP tool

A full-access key (ss_sk_…), or an editor or owner signed in.

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X POST "https://sniffington.com/api/v1/views" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme"}'

Update a saved view

PATCH /api/v1/views/{view}

update_view Write MCP tool

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Example

curl -X PATCH "https://sniffington.com/api/v1/views/{view}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme","project_id":"…"}'

Delete a saved view

DELETE /api/v1/views/{view}

delete_view Write MCP tool

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X DELETE "https://sniffington.com/api/v1/views/{view}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Recent scans

GET /api/v1/runs

list_runs Read MCP tool

Per project: what each source returned, how much was new, and any source errors.

Any API key or OAuth token, or a signed-in member.

Parameters

Example

curl "https://sniffington.com/api/v1/runs" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Scan status

GET /api/v1/scans/status

get_scan_status Read MCP tool

What's scanning now, what's queued, and when each project is next due.

Any API key or OAuth token, or a signed-in member.

Example

curl "https://sniffington.com/api/v1/scans/status" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Scan every project now

POST /api/v1/scans

scan_now Write MCP tool

A full-access key (ss_sk_…), or an editor or owner signed in.

Example

curl -X POST "https://sniffington.com/api/v1/scans" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

List webhooks

GET /api/v1/webhooks

list_webhooks Read MCP tool

Every webhook endpoint in the workspace. Secrets are never returned here; secret_hint is the last 4 characters.

Any API key or OAuth token, or a signed-in member.

Returns

Webhook[]

Example

curl "https://sniffington.com/api/v1/webhooks" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Create a webhook

POST /api/v1/webhooks

create_webhook Write MCP tool

Events are POSTed as JSON and signed per Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature headers). The signing secret is in this response only, so store it now.

A full-access key (ss_sk_…), or an editor or owner signed in.

Request body

JSON, sent with Content-Type: application/json.

Returns

Webhook & { secret }

Example

curl -X POST "https://sniffington.com/api/v1/webhooks" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/social-scout"}'

Get a webhook

GET /api/v1/webhooks/{webhook}

get_webhook Read MCP tool

Any API key or OAuth token, or a signed-in member.

Parameters

Returns

Webhook

Example

curl "https://sniffington.com/api/v1/webhooks/{webhook}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Update a webhook

PATCH /api/v1/webhooks/{webhook}

update_webhook Write MCP tool

Turning a webhook back on (enabled: true) clears its failure count and the reason it was turned off.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Returns

Webhook

Example

curl -X PATCH "https://sniffington.com/api/v1/webhooks/{webhook}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/social-scout","events":["…"]}'

Delete a webhook

DELETE /api/v1/webhooks/{webhook}

delete_webhook Write MCP tool

Stops deliveries and deletes its delivery log.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X DELETE "https://sniffington.com/api/v1/webhooks/{webhook}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Rotate a webhook's signing secret

POST /api/v1/webhooks/{webhook}/rotate-secret

rotate_webhook_secret Write MCP tool

The old secret stops working immediately. The new one is in this response only.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Returns

{ id, secret }

Example

curl -X POST "https://sniffington.com/api/v1/webhooks/{webhook}/rotate-secret" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Send a test event

POST /api/v1/webhooks/{webhook}/test

test_webhook Write MCP tool

Queues a signed "test.ping" event to this endpoint right away, even if the webhook is turned off. Check list_webhook_deliveries for the result.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Returns

{ delivery_id }

Example

curl -X POST "https://sniffington.com/api/v1/webhooks/{webhook}/test" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

List a webhook's deliveries

GET /api/v1/webhooks/{webhook}/deliveries

list_webhook_deliveries Read MCP tool

Newest first. Deliveries are kept for 30 days.

Any API key or OAuth token, or a signed-in member.

Parameters

Returns

{ data: Delivery[], total }

Example

curl "https://sniffington.com/api/v1/webhooks/{webhook}/deliveries" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Replay a delivery

POST /api/v1/webhook-deliveries/{delivery}/replay

replay_webhook_delivery Write MCP tool

Queues the same event again (same payload and webhook-id, so receivers can dedupe) as a new delivery.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Returns

{ delivery_id }

Example

curl -X POST "https://sniffington.com/api/v1/webhook-deliveries/{delivery}/replay" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

List webhook event types

GET /api/v1/webhook-events

list_webhook_events Read MCP tool

Every event type a webhook can subscribe to. test_webhook also sends a "test.ping" to any endpoint.

Any API key or OAuth token, or a signed-in member.

Example

curl "https://sniffington.com/api/v1/webhook-events" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

The current workspace

GET /api/v1/workspace

get_workspace Read MCP tool

Name, plan and timezone of the workspace this credential belongs to.

Any API key or OAuth token, or a signed-in member.

Example

curl "https://sniffington.com/api/v1/workspace" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Rename the workspace or change its timezone / default scan cadence

PATCH /api/v1/workspace

update_workspace Owner

A workspace owner signed in to the app. API keys can't call it.

Request body

JSON, sent with Content-Type: application/json.

List members

GET /api/v1/members

list_members Read MCP tool

Any API key or OAuth token, or a signed-in member.

Example

curl "https://sniffington.com/api/v1/members" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Change a member's role

PATCH /api/v1/members/{user}

update_member Owner

A workspace owner signed in to the app. API keys can't call it.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Remove a member

DELETE /api/v1/members/{user}

remove_member Owner

A workspace owner signed in to the app. API keys can't call it.

Parameters

List invites

GET /api/v1/invites

list_invites Owner

A workspace owner signed in to the app. API keys can't call it.

Invite someone

POST /api/v1/invites

create_invite Owner

Returns an invite link, valid for 7 days. It's emailed too.

A workspace owner signed in to the app. API keys can't call it.

Request body

JSON, sent with Content-Type: application/json.

Revoke an invite

DELETE /api/v1/invites/{invite}

revoke_invite Owner

A workspace owner signed in to the app. API keys can't call it.

Parameters

Usage this month

GET /api/v1/usage

get_usage Read MCP tool

Mentions collected and judged, metered source calls and LLM tokens, against the plan's limits.

Any API key or OAuth token, or a signed-in member.

Example

curl "https://sniffington.com/api/v1/usage" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

List API keys

GET /api/v1/api-keys

list_api_keys Owner

A workspace owner signed in to the app. API keys can't call it.

Create an API key

POST /api/v1/api-keys

create_api_key Owner

The key is shown once. Read-only keys can't change anything.

A workspace owner signed in to the app. API keys can't call it.

Request body

JSON, sent with Content-Type: application/json.

Revoke an API key

DELETE /api/v1/api-keys/{key}

revoke_api_key Owner

A workspace owner signed in to the app. API keys can't call it.

Parameters

List connected apps

GET /api/v1/oauth/connections

list_oauth_connections Owner

Apps (Claude, ChatGPT, Codex and other MCP clients) that members connected over OAuth, with their access and when their sign-in lapses.

A workspace owner signed in to the app. API keys can't call it.

Disconnect an app

DELETE /api/v1/oauth/connections/{client}

revoke_oauth_connection Owner

Revokes every token the app holds for this workspace. It has to be approved again to reconnect.

A workspace owner signed in to the app. API keys can't call it.

Parameters

List alerts

GET /api/v1/alerts

list_alerts Read MCP tool

Digests and rule alerts. With project, that project's alerts plus the ones that cover every project.

Any API key or OAuth token, or a signed-in member.

Parameters

Returns

Alert[]

Example

curl "https://sniffington.com/api/v1/alerts" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Create an alert

POST /api/v1/alerts

create_alert Write MCP tool

Email, Slack or Discord. Each workspace can send 30 alert emails and 200 Slack or Discord messages a day (self-hosted installs set the email cap with SCOUT_ALERT_EMAILS_PER_DAY).

A full-access key (ss_sk_…), or an editor or owner signed in.

Request body

JSON, sent with Content-Type: application/json.

Returns

Alert

Example

curl -X POST "https://sniffington.com/api/v1/alerts" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"digest","name":"Acme","channel":"email","target":"…"}'

Get an alert

GET /api/v1/alerts/{alert}

get_alert Read MCP tool

Any API key or OAuth token, or a signed-in member.

Parameters

Returns

Alert

Example

curl "https://sniffington.com/api/v1/alerts/{alert}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Update an alert

PATCH /api/v1/alerts/{alert}

update_alert Write MCP tool

Send only what changes. filters replaces the whole filter set.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Request body

JSON, sent with Content-Type: application/json.

Returns

Alert

Example

curl -X PATCH "https://sniffington.com/api/v1/alerts/{alert}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"digest","name":"Acme"}'

Delete an alert

DELETE /api/v1/alerts/{alert}

delete_alert Write MCP tool

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Example

curl -X DELETE "https://sniffington.com/api/v1/alerts/{alert}" \
  -H "Authorization: Bearer $SCOUT_API_KEY"

Send a test now

POST /api/v1/alerts/{alert}/test

test_alert Write MCP tool

Sends a real message: a digest of the last 24 hours, or for a rule the latest matching mention. With nothing to show, it sends a clearly marked sample. Counts toward the daily cap.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

Returns

{ sent, channel, detail }

Example

curl -X POST "https://sniffington.com/api/v1/alerts/{alert}/test" \
  -H "Authorization: Bearer $SCOUT_API_KEY"