RXrxfoodapp
webhook

Called by Zapier when a self-service signup form on SquareSpace is submitted.

Changed on
post/webhooks/patient-signup-form

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/webhooks/patient-signup-form
  • Auth
    none required

Request body

emailstring required
first_namestring required
first_report_datestring nullable

calendar date in format YYYY-MM-DD

hospital_patient_custom_fieldsobject nullable
hospital_patient_external_idstring nullable
last_namestring required
localestring nullable
patient_type'research' | 'collaboration' | 'wellness' | 'obesity' | 'diabetes' | 'metabolic syndrome' | 'weight loss' | 'migraine' | 'gastroesophageal reflux' | 'gi discomfort' | 'vertigo' | 'sleep apnea' | 'rxlife' | 'dexcom' | 'menopause' | 'insurance' nullable
phone_numberstring nullable
signup_metadata_non_sensitiveobject nullable

Additional signup metadata that does not contain sensitive information. Safe to send to, ex, Metabase and product analytics providers. Currently included in a PatientSignupMetadata telemetry_event. UTM parameters (utm_source, utm_medium, utm_campaign, utm_term, utm_content) should be included here for marketing attribution.

signup_metadata_sensitiveobject nullable

Additional signup metadata that contains sensitive information (PII, PHI, etc). Will not be sent to, ex, Metabase and product analytics providers. Currently included in a PatientSignupMetadata telemetry_event.

subscription_expiration_datestring nullable

calendar date in format YYYY-MM-DD

subscription_name'none' | 'three-day' | 'five-day' | 'seven-day' | 'ten-day' | 'one-month' | 'cgm14' | '14-day' | '21-day' | '28-day' | 'custom' nullable
subscription_type'single' | 'weekly' | 'monthly' | 'bi-weekly' | '4-weeks' | 'custom' nullable
tracking_start_datestring nullable

calendar date in format YYYY-MM-DD

Example request

{
  "first_report_date": "2019-01-02",
  "subscription_expiration_date": "2019-01-02",
  "tracking_start_date": "2019-01-02"
}

Response

Patient created or attached

patient_idinteger required

The created or attached patient

Changes