Sign in
webhook

Called by clinician signup form

Creates a clinic and clinicians. Default clinic feature flags are merged into clinic.flags_raw for every request, based on clinic.clinic_type (wellness vs diabetes/obesity presets); explicit flags in the request body override defaults. When create_hospital query parameter is true, also creates a new hospital using the clinic name. In that case, hospital_id in the request body becomes optional.

post/webhooks/clinician-signup-form

Query parameters

create_hospitalboolean

If true, creates a new hospital using the clinic name. When enabled, hospital_id in the request body becomes optional.

Request body

countrystring nullable

Country for the hospital when create_hospital=true. Valid values are 'Canada' or 'USA'. Aliases 'US' and 'United States' are accepted and normalized to 'USA'. Defaults to 'Canada' if not provided.

hospital_idinteger 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.

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.

Example request

{
  "clinic": {
    "default_report_template": [
      "clinical_summary_statement",
      "calories_by_period",
      "carbs_by_period",
      "fasting_windows",
      "average_plate_serv",
      "macronutrient_distribution",
      "micronutrient_summary_table",
      "diet_quality_score",
      "carbohydrate_frequency",
      "GI_food_list",
      "glycemic_index_frequency",
      "average_fats_frequency",
      "average_beverage_frequency",
      "average_grains_frequency",
      "average_proteins_frequency",
      "food_dump",
      "supplements"
    ],
    "flags_raw": {
      "clinic_default_days_until_report_date": "30",
      "clinic_default_patient_age": "30",
      "clinic_default_patient_sex": "female",
      "clinic_default_report_include_supplements_in_food_dump": true,
      "clinic_default_report_include_supplements_in_rdi": true,
      "clinic_default_subscription_name": "three-day",
      "clinic_default_user_locale": "en",
      "clinic_invitation_email_cadence": "1,2,7,14",
      "clinic_maximum_meal_capture_period_in_days_before_subscription": "0",
      "clinic_report_identity_mode": "anonymous",
      "clinic_report_judge_confidence_min": "0.7",
      "clinic_subscription_reminder_email_cadence": "1,7,-30",
      "clinic_subscription_types": "single",
      "clinician_oversight_of_patient": "clinician",
      "clinician_prevent_new_patients_after_date": "2020-01-01",
      "email_template_id_clinic_logging_completion": "en:xxx",
      "email_template_id_clinic_logging_starts_tomorrow": "en:xxx",
      "email_template_id_clinic_onboarding": "en:xxx",
      "email_template_id_clinic_registered_but_no_meals": "en:xxx",
      "email_template_id_clinic_reminder_to_continue_logging": "en:xxx",
      "email_template_id_clinic_report_available": "en:xxx",
      "email_template_id_clinic_thirty_day_subscription_inactive_logging_reminder": "en:xxx",
      "email_template_id_clinic_upcoming_subscription": "en:xxx",
      "email_template_id_returning_invitation": "en:xxx",
      "lifecycle_messaging_variant_patient_invited": "clinician",
      "lifecycle_messaging_variant_patient_logging_completed": "clinician",
      "lifecycle_messaging_variant_patient_report_available": "clinician",
      "lifecycle_messaging_variant_patient_subscription_notification": "clinician",
      "lifecycle_messaging_variant_patient_subscription_reminder": "clinician",
      "patient_app_extended_logging_types": "exercise, insulin",
      "patient_app_hide_meal_after_n_hours": "5",
      "patient_app_key_nutrients": "protein_g, fat_g, default_carbs_g, energy_kcal",
      "patient_app_nutritional_insights": true,
      "patient_app_nutritional_insights_sections_to_hide": "ultraprocessed foods",
      "patient_app_partner_branding": "dexcom",
      "patient_app_partner_oauth_provider": "dexcom",
      "patient_app_primary_macronutrient": "default_carbs_g",
      "patient_app_primary_macronutrient_can_edit": true,
      "patient_app_show_dev_settings": true,
      "patient_app_show_diet_score": true,
      "patient_app_show_macro_nutrition_card": true,
      "patient_app_show_nutrition_data_and_insights": true,
      "patient_app_use_timeline": true,
      "patient_app_use_v3_ui": true,
      "patient_can_view_pdf_reports": true,
      "patient_default_measure_system": "metric, imperial, auto, or none",
      "patient_goals_can_edit": true,
      "patient_preferred_nutrition_source": "usda",
      "patient_show_cals": true,
      "patient_show_carbs": true,
      "patient_show_gender": true,
      "patient_show_total_carbs": true,
      "patient_use_exercise": true,
      "patient_use_medication": true,
      "patient_use_question": true,
      "patient_use_sleep": true
    }
  }
}

Response

successful operation

Changes