---
title: "Called by Zapier when a self-service signup form on SquareSpace is submitted."
method: POST
path: "/webhooks/patient-signup-form"
tags: ["webhook"]
---

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

`POST /webhooks/patient-signup-form`

## Request body

- CreatePatientFromClinicianRequest
  - `clinic_id` union — clinic id must be provided when clinic_invitation_code is not provided
    - integer
    - string
  - `clinic_invitation_code` union — if provided, clinic routing uses the clinic associated with the invitation code
    - unknown
    - integer
    - string
  - `diet_restrictions` CreatePatientDietRestrictionRequest[], nullable
    - `comment` string, nullable
    - `name` string, required
  - `email` string, required
  - `first_name` string, required
  - `first_report_date` string, nullable — calendar date in format YYYY-MM-DD
  - `flags_raw` PostPatchPatientFlags, nullable
    - `patient_app_extended_logging_types` string, nullable
    - `patient_glucose_units_mmol_l` boolean, nullable
    - `patient_show_cals` boolean, nullable
    - `patient_show_carbs` boolean, nullable
  - `hospital_patient_custom_fields` object, nullable
  - `hospital_patient_external_id` string, nullable
  - `last_name` string, required
  - `locale` string, nullable
  - `motivations` CreatePatientMotivationRequest[], nullable
    - `comment` string, nullable — text for 'other' types, or other user comments. Max 256 char
    - `name` string, required
  - `patient_type` 'research' | 'collaboration' | 'wellness' | 'obesity' | 'diabetes' | 'metabolic syndrome' | 'weight loss' | 'migraine' | 'gastroesophageal reflux' | 'gi discomfort' | 'vertigo' | 'sleep apnea' | 'rxlife' | 'dexcom' | 'menopause', nullable
  - `phone_number` string, nullable
  - `signup_metadata_non_sensitive` object, 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_sensitive` object, 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_date` string, 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_date` string, nullable — calendar date in format YYYY-MM-DD

## Response `200`

Patient created or attached

- PatientSignupWebhookResponse
  - `patient_id` integer, required — The created or attached patient

---

[API](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server.md) · [All operations](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server/llms.txt) · [OpenAPI document](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server/revisions/c17aca2782f6?raw)