NEnexhealth
Webhook Subscriptions

View webhook subscriptions (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Changes query params event, resource_type; adds response field data[].version.

This endpoint lists all webhook subscriptions on the given webhook endpoint, optionally filtered by resource_type or event; when a subdomain is provided, results are scoped to that institution.

get/webhook_endpoints/{id}/webhook_subscriptions

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/webhook_endpoints/{id}/webhook_subscriptions
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Webhook Endpoint ID

Query parameters

subdomainstring

Used to scope the request to the specified institution

resource_type'Adjustment' | 'AdjustmentType' | 'Appointment' | 'Charge' | 'Claim' | 'Document' | 'FeeSchedule' | 'FormResponse' | 'FormSchema' | 'Insurance' | 'LocationDataReadiness' | 'MedicalHistory' | 'Message' | 'Onboarding' | 'Patient' | 'PatientInsuranceCoverage' | 'Payment' | 'PaymentType' | 'Procedure' | 'ProcedureCode' | 'Provider' | 'SyncStatus' | 'TreatmentPlan' | 'WorkingHour'

Filter by subscribed resource

event'adjustment_created' | 'adjustment_updated' | 'adjustment_deleted' | 'adjustment_insertion' | 'adjustment_type_created' | 'adjustment_type_updated' | 'appointment_insertion' | 'appointment_created' | 'appointment_updated' | 'appointment_requested' | 'charge_created' | 'charge_updated' | 'charge_deleted' | 'claim_created' | 'claim_updated' | 'claim_deleted' | 'document_insertion' | 'fee_schedule_created' | 'fee_schedule_updated' | 'form_response_insertion' | 'form_schema_created' | 'form_schema_deleted' | 'insurance_plan_insertion' | 'insurance_coverage_insertion' | 'insurance_coverage_deleted' | 'location_data_ready' | 'medical_history_item_created' | 'medical_history_item_updated' | 'medical_history_patient_items_updated' | 'message_created' | 'message_updated' | 'onboarding_created' | 'onboarding_updated' | 'onboarding_availability_ready' | 'patient_created' | 'patient_updated' | 'patient_insertion' | 'patient_update' | 'patient_insurance_created' | 'patient_insurance_updated' | 'payment_created' | 'payment_updated' | 'payment_deleted' | 'payment_insertion' | 'payment_type_created' | 'payment_type_updated' | 'procedure_created' | 'procedure_updated' | 'procedure_code_created' | 'procedure_code_updated' | 'procedure_code_deleted' | 'provider_created' | 'provider_updated' | 'sync_status_read_change' | 'sync_status_write_change' | 'treatment_plan_created' | 'treatment_plan_updated' | 'treatment_plan_deleted' | 'working_hour_created' | 'working_hour_updated'

Filter by event name

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 1,
      "webhook_endpoint_id": 1,
      "institution_id": 1,
      "resource_type": "Appointment",
      "event": "appointment_insertion",
      "active": true,
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "version": "v3.1.0"
    }
  ],
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.