Webhook event

`digital_form_response.completed`

A Patient completed a DigitalFormResponse.

Payload schema

api_versionanyrequired
contextobject
Present only when source is api. Identifies the acting project and API key.
- developer_platform_api_key_idstring | null · uuid
- developer_platform_project_idstring | null · uuid
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
dataobjectrequired
- objectobjectrequired
  - answersarrayrequired
    The answers currently recorded for the DigitalFormResponse.
    - itemsobject
      - attachment_urlstring | null · urirequired
        The temporary URL for an attached answer.
      - date_valuestring | null · daterequired
        The date supplied for a date question.
      - digital_form_questionobjectrequired
        A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer.
        choicesarrayrequired
        The choices available for a choice question.
        itemsobject
        idstring · uuidrequired
        The identifier of the DigitalFormQuestionChoice.
        numerical_valuenumber | nullrequired
        The optional numerical value assigned to the choice.
        text_valuestring | nullrequired
        The optional machine-readable text value assigned to the choice.
        titlestringrequired
        The choice shown to the Patient.
        help_textstring | nullrequired
        The supplementary guidance shown with the question.
        idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
        is_answer_requiredbooleanrequired
        Whether the Patient must answer the question.
        list_order_numberinteger | nullrequired
        The position of the question in the DigitalForm.
        question_typestringrequired
        The input and consent behavior of the question.
        Allowed values: consent_required | information_statement | multiple_choice_input | single_choice_input | text_input | number_input | date_input | signature_input
        titlestringrequired
        The question shown to the Patient.
      - digital_form_question_choice_idstring | null · uuidrequired
        The selected DigitalFormQuestionChoice.
      - digital_form_question_idstring · uuidrequired
        The DigitalFormQuestion answered.
      - has_consentedboolean | nullrequired
        Whether the Patient granted the requested consent.
      - idstring · uuidrequired
        The identifier of the DigitalFormQuestionAnswer.
      - numerical_valuenumber | nullrequired
        The numerical answer.
      - text_valuestring | nullrequired
        The text answer or selected choice title.
  - booking_idstring | null · uuidrequired
    The Booking associated with the response.
  - completed_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - digital_formobjectrequired
    - attachment_urlstring | null · urirequired
      The temporary URL for the attachment displayed with the DigitalForm.
    - created_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - objectanyrequired
      Discriminator value emitted at object.
    - patient_instructionsstring | nullrequired
      The sanitized instructions shown to the Patient.
    - questionsarrayrequired
      The ordered questions included in the DigitalForm.
      - itemsobject
        A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer.
        choicesarrayrequired
        The choices available for a choice question.
        itemsobject
        idstring · uuidrequired
        The identifier of the DigitalFormQuestionChoice.
        numerical_valuenumber | nullrequired
        The optional numerical value assigned to the choice.
        text_valuestring | nullrequired
        The optional machine-readable text value assigned to the choice.
        titlestringrequired
        The choice shown to the Patient.
        help_textstring | nullrequired
        The supplementary guidance shown with the question.
        idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
        is_answer_requiredbooleanrequired
        Whether the Patient must answer the question.
        list_order_numberinteger | nullrequired
        The position of the question in the DigitalForm.
        question_typestringrequired
        The input and consent behavior of the question.
        Allowed values: consent_required | information_statement | multiple_choice_input | single_choice_input | text_input | number_input | date_input | signature_input
        titlestringrequired
        The question shown to the Patient.
    - titlestringrequired
      The title of the DigitalForm.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - due_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - linksobjectrequired
    URLs to related resources.
    - patientstring · urirequired
      The full URL of a related resource.
    - transmissionsstring · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - patient_idstring · uuidrequired
    The Patient asked to complete the DigitalForm.
  - statusstringrequired
    The completion status of the DigitalFormResponse.
    Allowed values: awaiting_completion | partially_completed | overdue | completed
  - total_scoreinteger | nullrequired
    The sum of numerical answers configured to contribute to the score.
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
developer_platform_project_idstring | null · uuidrequired
The project ID whose credential caused the change. Null for dashboard events.
idstringrequired
Event identifier prefixed with evt_.
livemodebooleanrequired
false for test-event deliveries.
objectanyrequired
sourcestringrequired
Origin of the change. api means a Developer Platform mutation; dashboard means a Carebit-initiated change.
Allowed values: api | dashboard
typeanyrequired

Example

{
  "id": "evt_00000000-0000-4000-8000-000000000012",
  "object": "event",
  "api_version": "v1",
  "created_at": "2026-01-01T09:00:00Z",
  "data":  … }
    "object":  … }
      "id": "00000000-0000-4000-8000-000000000021",
      "object": "digital_form_response",
      "answers":  … ]
         … }
          "id": "00000000-0000-4000-8000-000000000024",
          "attachment_url": null,
          "date_value": null,
          "digital_form_question":  … }
            "id": "00000000-0000-4000-8000-000000000022",
            "choices":  … ]
               … }
                "id": "00000000-0000-4000-8000-000000000023",
                "numerical_value": 1,
                "text_value": "yes",
                "title": "Yes"
              }
            ],
            "help_text": "Select every option that applies.",
            "is_answer_required": true,
            "list_order_number": 1,
            "question_type": "single_choice_input",
            "title": "Do you consent to the procedure?"
          },
          "digital_form_question_choice_id": "00000000-0000-4000-8000-000000000023",
          "digital_form_question_id": "00000000-0000-4000-8000-000000000022",
          "has_consented": null,
          "numerical_value": 1,
          "text_value": "Yes"
        }
      ],
      "booking_id": "00000000-0000-4000-8000-000000000001",
      "completed_at": "2026-01-01T09:00:00Z",
      "created_at": "2026-01-01T09:00:00Z",
      "digital_form":  … }
        "id": "00000000-0000-4000-8000-000000000020",
        "object": "digital_form",
        "attachment_url": null,
        "created_at": "2026-01-01T09:00:00Z",
        "patient_instructions": "Please complete this consent form.",
        "questions":  … ]
           … }
            "id": "00000000-0000-4000-8000-000000000022",
            "choices":  … ]
               … }
                "id": "00000000-0000-4000-8000-000000000023",
                "numerical_value": 1,
                "text_value": "yes",
                "title": "Yes"
              }
            ],
            "help_text": "Select every option that applies.",
            "is_answer_required": true,
            "list_order_number": 1,
            "question_type": "single_choice_input",
            "title": "Do you consent to the procedure?"
          }
        ],
        "title": "Pre-operative consent",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "due_at": "2026-01-01T08:30:00Z",
      "links":  … }
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004",
        "transmissions": "https://api.carebit.co/v1/transmissions?patient_id=00000000-0000-4000-8000-000000000004&resource_type=digital_form_response"
      },
      "patient_id": "00000000-0000-4000-8000-000000000004",
      "status": "completed",
      "total_score": 0,
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "digital_form_response.completed"
}

Prefer plain text? Append ?format=md or send Accept: text/markdown to receive this page as raw Markdown.