Webhook Event Types

Learn about the webhooks event types, their payloads and availabilities.

Webhook events and payloads

Workouts

Type: workout.created

Payload:

{
    "id": integer,
    "activityId":integer,
    "userId": string,
    "activityName": string,
    "calories": float,
    "distance": float,
    "duration": integer,
    "start": string,
    "end": string,
    "ratings": {
      "energy": integer | null,
      "difficulty": integer | null,
      "instructor": integer | null
    },
    "createdAt": string,
    "updatedAt": string,
    "workoutRecommendationId": integer | null,
    "workoutIntensity": integer | null,
    "externalMetadata": object
}

Insights

Type: insight.created

Payload:

{
    "id": integer,
    "userId": string,
    "insight": string,
    "additionalFields": {
      <insight type related data>
    },
    "createdAt": string,
    "updatedAt": string,
    "lastProcessedAt": string | null
}

Webhook event types availability