API Endpoints

The Nudge API provides endpoints for managing contacts and review requests.

Core Action

Add Contact (Triggers Automatic Review Request)

• POST /api/zapier/send-review-request - Add a contact and Nudge automatically sends the review request

Adding a contact triggers an automatic review request.

Supporting Endpoints

User Information

• GET /api/zapier/me - Get authenticated user information

Connection Management

• GET /api/zapier/status - Check if your integration is working
• GET /api/zapier/send-review-request/fields - Get field definitions for Zapier UI

OAuth Authentication

• GET /api/oauth/zapier/authorize - Start OAuth flow
• POST /api/oauth/zapier/token - Exchange tokens
• POST /api/oauth/zapier/revoke - Disconnect integration

Common Headers

All authenticated endpoints require:

Authorization: Bearer your-access-token
Content-Type: application/json

Error Handling

All API errors follow a consistent format:

{
  "error": "error_code",
  "error_description": "Human-readable error message"
}

Common Error Codes

HTTP Status	Error Code	Description
400	invalid_request	Missing or invalid parameters
401	unauthorized	Invalid or expired access token
401	invalid_client	Invalid OAuth client credentials
400	invalid_grant	Invalid authorization code or refresh token
404	not_found	Resource not found
500	server_error	Internal server error