Skip to main content
API docs by Redocly

Nudge API (1.0.0)

Download OpenAPI specification:Download

E-mail: support@justanudge.co License: Private

Automated review management API for customer feedback collection.

The API handles review request lifecycle management including contact creation, request scheduling, delivery methods (SMS/email), and automated follow-up sequences.

Core Action

Add contacts to trigger automatic review requests

Add Contact (Send Review Request)

Creates a contact and initiates an automated review request. Review requests are sent automatically based on the specified delay_hours parameter.

Authorizations:
oauth2
Request Body schema: application/json
required
One of
first_name
string

Contact's first name

last_name
string

Contact's last name

email
required
string <email>

Contact's email address (required if no mobile_phone_number)

mobile_phone_number
string

Contact's mobile phone number in E.164 format (required if no email)

company_name
string

Contact's company name

delay_hours
integer >= 0
Default: 0

Hours to wait before sending the review request

object

Additional custom data

Responses

Request samples

Content type
application/json
{
  • "first_name": "Jane",
  • "last_name": "Smith",
  • "email": "jane@example.com",
  • "mobile_phone_number": "+12125551234",
  • "company_name": "Smith Industries",
  • "delay_hours": 24,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
  • "contact_name": "string",
  • "contact_email": "user@example.com",
  • "contact_phone": "string",
  • "scheduled_for": "2019-08-24T14:15:22Z",
  • "status": "scheduled",
  • "message": "string"
}

Get Input Fields

Returns input field definitions for integration configuration

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
{
  • "fields": [
    ]
}

Account

User information and connection status

Get User Information

Returns information about the authenticated user

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "business_name": "string"
}

Check Connection Status

Verifies if the current OAuth token is valid and active

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "auth_type": "oauth",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "scopes": [
    ],
  • "expires_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_used_at": "2019-08-24T14:15:22Z"
}

OAuth

OAuth 2.0 authentication flow

OAuth Authorization Endpoint

Initiates the OAuth 2.0 authorization flow

Authorizations:
oauth2
query Parameters
client_id
required
string

Your OAuth client ID

redirect_uri
required
string

Your registered redirect URI

response_type
required
string
Value: "code"

Must be 'code'

state
string

Random string to prevent CSRF attacks

scope
string
Example: scope=read write

Space-separated list of scopes

code_challenge
string

PKCE code challenge

code_challenge_method
string
Value: "S256"

PKCE method

Responses

Response samples

Content type
application/json
{
  • "error": "invalid_request",
  • "error_description": "string"
}

OAuth Token Endpoint

Exchanges authorization code for access token or refreshes access token

Authorizations:
oauth2
Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Enum: "authorization_code" "refresh_token"

Type of grant

client_id
required
string

Your OAuth client ID

client_secret
required
string

Your OAuth client secret

code
string

Authorization code (required for authorization_code grant)

redirect_uri
string

Same redirect URI used in authorization (required for authorization_code grant)

refresh_token
string

Refresh token (required for refresh_token grant)

code_verifier
string

PKCE verifier (optional)

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 3600,
  • "refresh_token": "string",
  • "scope": "read write"
}

Revoke OAuth Tokens

Revokes all active OAuth tokens for the authenticated user

Authorizations:
oauth2
Request Body schema: application/json
optional
token
string

Specific token to revoke (optional, revokes all if not provided)

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Tokens revoked successfully",
  • "revoked_count": 2
}