Review Request API

Every integration posts to one endpoint: its connection URL. This page describes that endpoint for anyone building against it, including the Zapier app and the Custom Webhook (API) integration on the Scale plan.

Endpoint


POST https://app.praisepipeline.com/api/webhooks/ingest/<token>
Content-Type: application/json

Copy the URL from Integrations → Connect on the integration you’re using. The private token in the path is the credential: there’s no separate API key or header. Treat the URL like a password. Disconnect revokes it immediately, and reconnecting issues a new one.

Request

Field	Required	Description
`customer_email`	Yes	Where the review request is sent.
`customer_name`	No	Used to greet the customer.


{ "customer_email": "[email protected]", "customer_name": "Maya Rutherford" }

A body of { "is_test": true } verifies the connection (the integration shows as Active) without sending anything.

Responses

Status	Body	Meaning
`200`	`{"success": true}`	Scheduled. It’s sent after the delay set in Branding → Review requests.
`200`	`{"success": true, "message": "Test ping verified!"}`	The test request above.
`200`	Plain text, for example `Ignored: no customer email in this event`	Received, but nothing was sent. Not an error, so don’t retry.
`400`	Plain text	The body isn’t JSON.
`401`	Plain text	Unknown token: the URL is wrong, or was regenerated.
`403`	Plain text	The integration was disconnected, or a Custom Webhook connection is used on a plan below Scale.
`500`	`{"error": "Internal error"}`	Something failed on our side. Retry later.

The plain-text reasons for a 200 that sends nothing:

Ignored: no customer email in this event
Ignored: customer email is not a valid address
Customer in 60-day cooldown status (they reviewed in the last 60 days)
Customer was sent a review request within 60 days of this one's send date
Customer already has a review request queued
Review request volume cap reached for this billing period

Limits

Each customer is asked at most once every 60 days. See How Review Requests Work.
Your plan sets a monthly number of review requests (Plans & Billing).
Each connection routes to one location, fixed by the URL.