Skip to documentation

Automation rules, events and filters

Route new feedback to email or webhooks using explicit event filters and delivery logs.

Updated Read as Markdown

Start with one event and destination

Open Automations and create an email or webhook rule. Choose its scope, event and filters, then test the destination before relying on it.

Event Scope Typical use
feedback.created One inbox or the organization A rating/comment was submitted to an inbox
page_response.created Organization only A respondent submitted a Feedback Page

Current delivery implementations are email and webhook. A Slack rule type exists in the schema but delivery is not implemented; use a webhook-compatible integration or Zapier when you need to forward information to another service.

Create a rule through REST

bash
curl https://api.pollenate.dev/organizations/ORG_ID/automations \
  -H "X-Pollenate-Key: $POLLENATE_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Review NPS detractors",
    "scope": "inbox",
    "inboxId": "INBOX_ID",
    "type": "webhook",
    "target": "https://example.com/hooks/pollenate",
    "events": ["feedback.created"],
    "filters": { "npsCategory": "detractor", "hasComment": true }
  }'

Machine creation/update/test operations require an organization-wide admin key. Dashboard users need the applicable inbox-management permission. Email targets can contain comma-separated recipient addresses. Webhook setup and signing are covered in webhooks.

For a form-response rule, use scope: "organization", events: ["page_response.created"] and optionally filters.pageId. An inbox-scoped form-response rule fails validation.

Filters are explicit comparisons

Inbox feedback supports:

  • type and source: one string or a list.
  • minScore / maxScore: inclusive bounds.
  • scoreAbove / scoreBelow: exclusive bounds.
  • scoreEquals: exact match.
  • hasComment: true: a nonempty comment.
  • sentiment: "positive" | "negative": a thumbs-only shorthand for score 1 or 0, not AI sentiment analysis.
  • npsCategory: promoter (9–10), passive (7–8) or detractor (0–6), for NPS events.

Form-response filters support pageId and hasEmail: true. Feedback score/type filters do not inspect every answer in a survey. Empty filters match the event broadly, so begin with a narrowly selected inbox or page.

Delivery and testing

Use POST /organizations/ORG_ID/automations/RULE_ID/test or the dashboard Test action. The test sends a synthetic event to the real destination. It can send email or create records in an external system; choose a test destination first. It does not create a real inbox feedback event or survey response.

Inspect the returned status code and the destination. Normal automation execution is logged with event, status, HTTP status, duration and error details. A test action returning its wrapper's success flag does not prove the downstream service accepted the business action.

The dispatcher does not implement automatic delivery retries. Design critical receiving workflows to acknowledge quickly and queue work durably. Do not promise a customer an issue exists until the destination confirms it.

Private-form responses suppress organization automation rules. Use the form's permitted notification and sharing workflow instead of trying to forward private responses through a broad organization rule. For user notification preferences, see notifications.