Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.montereyfinancial.dev/llms.txt

Use this file to discover all available pages before exploring further.

Monterey receives engagement events from Campaigner via a webhook endpoint. These events power the analytics dashboard and bounce tracking.

Webhook endpoint

POST /campaign-events/webhook
This endpoint accepts event payloads from Campaigner and returns 202 Accepted. Events are processed asynchronously by the EmailCampaignEngagementEventService.

Event types

TypeDescription
openRecipient opened the email
clickRecipient clicked a link
bounceEmail bounced (hard or soft)
unsubscribeRecipient unsubscribed

Configuring Campaigner

Point Campaigner’s webhook configuration to your Monterey API’s public URL:
https://your-api-domain.com/campaign-events/webhook
The webhook endpoint does not require workspace scoping since events are matched to campaigns by their Campaigner identifiers.

Querying events

After events are ingested, query them through the events API:
curl "http://localhost:8000/campaign-events/?event_type=click&date_from=2026-03-01" \
  -H "Authorization: Bearer <token>" \
  -H "workspace_id: <workspace-id>"
Filter parameters:
ParameterTypeDescription
event_typestringFilter by event type
date_fromISO dateEvents after this date
date_toISO dateEvents before this date
pageintegerPage number for pagination
page_sizeintegerResults per page