Skip to content

Developers

MentionOwl API

Beta

Read MentionOwl data and manage signed outbound webhooks with scoped, expiring API keys.

Webhook events

user.created

A MentionOwl user account was created.

site.created

A site was added to the account.

site.deleted

A site was removed from the account.

monitoring.completed

A scheduled monitoring run completed.

visibility.dropped

Visibility fell past the configured alert threshold.

subscription.started

A paid subscription started.

subscription.updated

A paid subscription changed status or configuration.

subscription.cancelled

A paid subscription ended.

webhook.test

A test requested for a webhook endpoint.

REST contract

Endpoints

Try requests in Scalar
GET/api/meAccount

Get the current account

Returns the API-key owner and every owned or shared site.

GET/api/user/{id}Account

Get a user

Returns the key owner, or any user when called by an administrator.

GET/api/site/{domain}Sites

Get site metadata

Returns a site visible to the API-key owner.

GET/api/site/{domain}/metricsSites

Get visibility metrics

Returns the canonical current and previous visibility read model.

GET/api/site/{domain}/queriesSites

Get monitored answers and citations

Returns recent runs inside the site owner's history entitlement.

GET/api/admin/usersAdministration

List users

Administrator-only account operations view.

GET/api/admin/cronAdministration

Get cron health

Administrator-only scheduled job status and history.

GET/api/admin/usageAdministration

Get service usage

Administrator-only usage, queue, and account aggregates.

GET/api/webhooksWebhooks

List webhook endpoints

Lists redacted endpoint metadata.

POST/api/webhooksWebhooks

Create a webhook endpoint

Creates an endpoint. The signing secret is returned once.

PATCH/api/webhooks/{id}Webhooks

Update a webhook endpoint

Updates an owner-scoped endpoint.

DELETE/api/webhooks/{id}Webhooks

Delete a webhook endpoint

Deletes an endpoint and its delivery history.

POST/api/webhooks/{id}/testWebhooks

Send a test webhook

Immediately sends a webhook.test event.

POST/api/webhooks/{id}/rotate-secretWebhooks

Rotate a signing secret

Replaces the secret and returns it once.

GET/api/webhooks/{id}/deliveriesWebhooks

List webhook deliveries

Returns the latest 100 delivery attempts.

POST/api/webhooks/{id}/deliveries/{deliveryId}/retryWebhooks

Replay a failed delivery

Creates and immediately attempts a linked replay without mutating the original FAILED or RETRY audit row.