Payload reference

interface WebhookPayload {
  event_id: string; // Unique ID of the webhook event (response ID)
  event_type: "form_response"; // Always "form_response" for survey responses
  form_response: FormResponse; // The main response data
}

interface FormResponse {
  form_id: string; // Survey ID
  token: string; // Response token/ID
  submitted_at: string; // ISO 8601 UTC timestamp of when the response was submitted
  landed_at: string; // ISO 8601 UTC timestamp of when the user started the survey
  calculated?: {
    score?: number; // Calculated score
    [k: string]: unknown; // Additional calculated fields
  } | null;
  variables?: Variable[]; // Form variables coming from URL parameters
  hidden?: Record<string, string>; // Hidden fields (if present)
  definition: FormDefinition; // Definition of the survey structure
  answers: Answer[]; // User answers
  ending?: EndingRef; // Ending screen shown to the user
}

interface EndingRef {
  id: string; // ID of the ending screen shown
  ref?: string; // Optional reference
}

interface FormDefinition {
  id: string; // Survey ID (same as form_id)
  title: string; // Survey title
  fields: FieldDefinition[]; // Survey questions/fields
  endings?: EndingDefinition[]; // Possible ending screens
}

interface EndingDefinition {
  id: string; // ID of the ending screen
  ref?: string; // Optional reference
}

interface FieldDefinition {
  id: string; // Unique field ID
  title: string; // Question text
  type: FieldType; // Question type (see below)
  ref?: string; // Optional reference identifier
  allow_multiple_selections?: boolean; // For multiple choice questions
  allow_other_choice?: boolean; // Whether the "Other" option is available
  choices?: ChoiceDefinition[]; // Available choices (for choice questions)
  properties?: Record<string, unknown>; // Additional field properties
}

type FieldType =
  | "short_text"
  | "long_text"
  | "email"
  | "number"
  | "picture_choice"
  | "single_choice"
  | "multiple_choice"
  | "yes_no"
  | "opinion_scale"
  | "rating"
  | "swipe";

interface ChoiceDefinition {
  id: string; // Choice ID
  label: string; // Choice text/label
  ref?: string; // Optional reference
}

interface Variable {
  key: string; // Variable name
  type: "text" | "number"; // Variable type
  text?: string; // Text value (if the type is "text")
  number?: number; // Numeric value (if the type is "number")
}

// Reference to the field an answer is linked to
interface FieldReference {
  id: string;
  type: FieldType;
  ref?: string;
}

// Text Answer
interface TextAnswer {
  type: "text";
  text: string;
  field: FieldReference;
}

// Boolean Answer
interface BooleanAnswer {
  type: "boolean";
  boolean: boolean;
  field: FieldReference;
}

// Number Answer
interface NumberAnswer {
  type: "number";
  number: number;
  field: FieldReference;
}

// Single Choice Answer
interface SingleChoiceAnswer {
  type: "choice";
  choice: {
    id?: string;
    label?: string;
    ref?: string;
    other?: string; // Custom text if "Other" was selected
  };
  field: FieldReference;
}

// Multiple Choices Answer
interface MultipleChoicesAnswer {
  type: "choices";
  choices: {
    ids?: string[];
    labels?: string[];
    refs?: string[];
    other?: string;
  };
  field: FieldReference;
}