v71

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-032076961.5 MB
summary

Menstrual Cycle

postWebhookdaily.data.menstrual_cycle.*

Payload

event_type'daily.data.menstrual_cycle.created' | 'daily.data.menstrual_cycle.updated' required
user_idstring uuid required
client_user_idstring uuid required
team_idstring uuid required

Example payload

{
  "data": {
    "basal_body_temperature": [],
    "cervical_mucus": [],
    "contraceptive": [],
    "created_at": "2023-02-27T20:31:24+00:00",
    "cycle_end": "2024-05-01",
    "detected_deviations": [],
    "home_pregnancy_test": [],
    "home_progesterone_test": [],
    "id": "e1274c3e-c035-4bd7-86aa-2eb15d6d0137",
    "intermenstrual_bleeding": [
      {
        "date": "2024-04-17"
      }
    ],
    "is_predicted": false,
    "menstrual_flow": [
      {
        "date": "2024-04-07",
        "flow": "light"
      },
      {
        "date": "2024-04-10",
        "flow": "medium"
      },
      {
        "date": "2024-04-11",
        "flow": "heavy"
      }
    ],
    "ovulation_test": [],
    "period_end": "2024-04-11",
    "period_start": "2024-04-07",
    "sexual_activity": [
      {
        "date": "2024-04-13",
        "protection_used": true
      }
    ],
    "source": {
      "app_id": "com.apple.Health",
      "device_id": "550e8400-e29b-41d4-a716-446655440000",
      "provider": "apple_health_kit",
      "type": "app"
    },
    "source_app_id": "com.apple.Health",
    "source_provider": "apple_health_kit",
    "source_type": "app",
    "updated_at": "2023-02-28T01:22:38+00:00",
    "user_id": "cbd8b986-4225-4d36-8e2c-046ff2702769"
  }
}

Response

Successful Response

{"stackTrail":"webhooks:daily.data.menstrual_cycle.*:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}