Awell Docs

Real-time GraphQL subscriptions for activity, session, care flow, API call, and webhook events.

Subscriptions

`activityCompleted`

Emits when an activity is completed.

Arguments

Argument	Type	Required	Description
`only_patient_activities`	`Boolean`	No	Only emit events for patient activities
`pathway_id`	`String`	No	The ID of the care flow

Returns: Activity!

Example

subscription ActivityCompleted($only_patient_activities: Boolean, $pathway_id: String) {
  activityCompleted(only_patient_activities: $only_patient_activities, pathway_id: $pathway_id) {
    action
    action_component {
      definition_id
      release_id
      title
    }
    container_name
    context {
      action_id
      agent_config_id
      agent_id
      agent_thread_id
      instance_id
      pathway_id
      run_id
      step_id
      track_id
    }
    date
    expires_at
    form {
      definition_id
      id
      key
      metadata
      previous_answers {
        activity_id
        date
      }
      questions {
        dataPointValueType
        definition_id
        id
        key
        metadata
        page
        questionType
        title
        title_html
        userQuestionType
      }
      release_id
      title
      trademark
    }
    form_display_mode
    icon_url
    id
    isUserActivity
    metadata
    public
    reference_id
    reference_type
    resolution
    session_id
    status
    stream_id
  }
}

Variables:

{
  "only_patient_activities": true,
  "pathway_id": "<string>"
}

`activityCreated`

Emits when an activity is created.

Arguments

Argument	Type	Required	Description
`only_patient_activities`	`Boolean`	No	Only emit events for patient activities
`pathway_id`	`String`	No	The ID of the care flow

Returns: Activity!

Example

subscription ActivityCreated($only_patient_activities: Boolean, $pathway_id: String) {
  activityCreated(only_patient_activities: $only_patient_activities, pathway_id: $pathway_id) {
    action
    action_component {
      definition_id
      release_id
      title
    }
    container_name
    context {
      action_id
      agent_config_id
      agent_id
      agent_thread_id
      instance_id
      pathway_id
      run_id
      step_id
      track_id
    }
    date
    expires_at
    form {
      definition_id
      id
      key
      metadata
      previous_answers {
        activity_id
        date
      }
      questions {
        dataPointValueType
        definition_id
        id
        key
        metadata
        page
        questionType
        title
        title_html
        userQuestionType
      }
      release_id
      title
      trademark
    }
    form_display_mode
    icon_url
    id
    isUserActivity
    metadata
    public
    reference_id
    reference_type
    resolution
    session_id
    status
    stream_id
  }
}

Variables:

{
  "only_patient_activities": true,
  "pathway_id": "<string>"
}

`activityExpired`

Emits when an activity expires.

Arguments

Argument	Type	Required	Description
`only_patient_activities`	`Boolean`	No	Only emit events for patient activities
`pathway_id`	`String`	No	The ID of the care flow

Returns: Activity!

Example

subscription ActivityExpired($only_patient_activities: Boolean, $pathway_id: String) {
  activityExpired(only_patient_activities: $only_patient_activities, pathway_id: $pathway_id) {
    action
    action_component {
      definition_id
      release_id
      title
    }
    container_name
    context {
      action_id
      agent_config_id
      agent_id
      agent_thread_id
      instance_id
      pathway_id
      run_id
      step_id
      track_id
    }
    date
    expires_at
    form {
      definition_id
      id
      key
      metadata
      previous_answers {
        activity_id
        date
      }
      questions {
        dataPointValueType
        definition_id
        id
        key
        metadata
        page
        questionType
        title
        title_html
        userQuestionType
      }
      release_id
      title
      trademark
    }
    form_display_mode
    icon_url
    id
    isUserActivity
    metadata
    public
    reference_id
    reference_type
    resolution
    session_id
    status
    stream_id
  }
}

Variables:

{
  "only_patient_activities": true,
  "pathway_id": "<string>"
}

`activityUpdated`

Emits when an activity is updated.

Arguments

Argument	Type	Required	Description
`only_patient_activities`	`Boolean`	No	Only emit events for patient activities
`pathway_id`	`String`	No	The ID of the care flow

Returns: Activity!

Example

subscription ActivityUpdated($only_patient_activities: Boolean, $pathway_id: String) {
  activityUpdated(only_patient_activities: $only_patient_activities, pathway_id: $pathway_id) {
    action
    action_component {
      definition_id
      release_id
      title
    }
    container_name
    context {
      action_id
      agent_config_id
      agent_id
      agent_thread_id
      instance_id
      pathway_id
      run_id
      step_id
      track_id
    }
    date
    expires_at
    form {
      definition_id
      id
      key
      metadata
      previous_answers {
        activity_id
        date
      }
      questions {
        dataPointValueType
        definition_id
        id
        key
        metadata
        page
        questionType
        title
        title_html
        userQuestionType
      }
      release_id
      title
      trademark
    }
    form_display_mode
    icon_url
    id
    isUserActivity
    metadata
    public
    reference_id
    reference_type
    resolution
    session_id
    status
    stream_id
  }
}

Variables:

{
  "only_patient_activities": true,
  "pathway_id": "<string>"
}

`apiCallCreated`

Emits when an API call is created.

Arguments

Argument	Type	Required	Description
`pathway_id`	`String!`	Yes	The ID of the care flow

Returns: ApiCall!

Example

subscription ApiCallCreated($pathway_id: String!) {
  apiCallCreated(pathway_id: $pathway_id) {
    created_at
    id
    request {
      body
      endpoint
      headers {
        key
        value
      }
      method
    }
    responses {
      body
      date
      status
    }
    status
    title
  }
}

Variables:

{
  "pathway_id": "<string>"
}

`apiCallUpdated`

Emits when an API call is updated.

Arguments

Argument	Type	Required	Description
`pathway_id`	`String!`	Yes	The ID of the care flow

Returns: ApiCall!

Example

subscription ApiCallUpdated($pathway_id: String!) {
  apiCallUpdated(pathway_id: $pathway_id) {
    created_at
    id
    request {
      body
      endpoint
      headers {
        key
        value
      }
      method
    }
    responses {
      body
      date
      status
    }
    status
    title
  }
}

Variables:

{
  "pathway_id": "<string>"
}

`pathwayUpdated`

Emits when a care flow is updated.

Arguments

Argument	Type	Required	Description
`id`	`ID!`	Yes	The ID of the care flow

Returns: Pathway!

Example

subscription PathwayUpdated($id: ID!) {
  pathwayUpdated(id: $id) {
    complete_date
    created {
      date
      user_email
      user_id
      user_name
    }
    id
    is_archived
    latestActivities {
      action
      action_component {
        definition_id
        release_id
        title
      }
      container_name
      context {
        action_id
        agent_config_id
        agent_id
        agent_thread_id
        instance_id
        pathway_id
        run_id
        step_id
        track_id
      }
      date
      expires_at
      form {
        definition_id
        id
        key
        metadata
        release_id
        title
        trademark
      }
      form_display_mode
      icon_url
      id
      isUserActivity
      metadata
      public
      reference_id
      reference_type
      resolution
      session_id
      status
      stream_id
    }
    pathway_definition_id
    patient {
      id
      profile {
        birth_date
        email
        first_name
        last_name
        mobile_phone
        name
        national_registry_number
        patient_code
        patient_timezone
        phone
        preferred_language
        sex
      }
      tenant_id
    }
    patient_id
    release_id
    start_date
    status
    status_explanation
    stop_date
    title
    version
  }
}

Variables:

{
  "id": "<id>"
}

`sessionActivityCompleted`

Emits when an activity in a hosted session is completed.

Arguments

Argument	Type	Required	Description
`only_stakeholder_activities`	`Boolean`	No	Only emit events for stakeholder activities

Returns: Activity!

Example

subscription SessionActivityCompleted($only_stakeholder_activities: Boolean) {
  sessionActivityCompleted(only_stakeholder_activities: $only_stakeholder_activities) {
    action
    action_component {
      definition_id
      release_id
      title
    }
    container_name
    context {
      action_id
      agent_config_id
      agent_id
      agent_thread_id
      instance_id
      pathway_id
      run_id
      step_id
      track_id
    }
    date
    expires_at
    form {
      definition_id
      id
      key
      metadata
      previous_answers {
        activity_id
        date
      }
      questions {
        dataPointValueType
        definition_id
        id
        key
        metadata
        page
        questionType
        title
        title_html
        userQuestionType
      }
      release_id
      title
      trademark
    }
    form_display_mode
    icon_url
    id
    isUserActivity
    metadata
    public
    reference_id
    reference_type
    resolution
    session_id
    status
    stream_id
  }
}

Variables:

{
  "only_stakeholder_activities": true
}

`sessionActivityCreated`

Emits when an activity in a hosted session is created.

Arguments

Argument	Type	Required	Description
`only_stakeholder_activities`	`Boolean`	No	Only emit events for stakeholder activities

Returns: Activity!

Example

subscription SessionActivityCreated($only_stakeholder_activities: Boolean) {
  sessionActivityCreated(only_stakeholder_activities: $only_stakeholder_activities) {
    action
    action_component {
      definition_id
      release_id
      title
    }
    container_name
    context {
      action_id
      agent_config_id
      agent_id
      agent_thread_id
      instance_id
      pathway_id
      run_id
      step_id
      track_id
    }
    date
    expires_at
    form {
      definition_id
      id
      key
      metadata
      previous_answers {
        activity_id
        date
      }
      questions {
        dataPointValueType
        definition_id
        id
        key
        metadata
        page
        questionType
        title
        title_html
        userQuestionType
      }
      release_id
      title
      trademark
    }
    form_display_mode
    icon_url
    id
    isUserActivity
    metadata
    public
    reference_id
    reference_type
    resolution
    session_id
    status
    stream_id
  }
}

Variables:

{
  "only_stakeholder_activities": true
}

`sessionActivityExpired`

Emits when an activity in a hosted session expires.

Arguments

Argument	Type	Required	Description
`only_stakeholder_activities`	`Boolean`	No	Only emit events for stakeholder activities

Returns: Activity!

Example

subscription SessionActivityExpired($only_stakeholder_activities: Boolean) {
  sessionActivityExpired(only_stakeholder_activities: $only_stakeholder_activities) {
    action
    action_component {
      definition_id
      release_id
      title
    }
    container_name
    context {
      action_id
      agent_config_id
      agent_id
      agent_thread_id
      instance_id
      pathway_id
      run_id
      step_id
      track_id
    }
    date
    expires_at
    form {
      definition_id
      id
      key
      metadata
      previous_answers {
        activity_id
        date
      }
      questions {
        dataPointValueType
        definition_id
        id
        key
        metadata
        page
        questionType
        title
        title_html
        userQuestionType
      }
      release_id
      title
      trademark
    }
    form_display_mode
    icon_url
    id
    isUserActivity
    metadata
    public
    reference_id
    reference_type
    resolution
    session_id
    status
    stream_id
  }
}

Variables:

{
  "only_stakeholder_activities": true
}

`sessionActivityUpdated`

Emits when an activity in a hosted session is updated.

Arguments

Argument	Type	Required	Description
`only_stakeholder_activities`	`Boolean`	No	Only emit events for stakeholder activities

Returns: Activity!

Example

subscription SessionActivityUpdated($only_stakeholder_activities: Boolean) {
  sessionActivityUpdated(only_stakeholder_activities: $only_stakeholder_activities) {
    action
    action_component {
      definition_id
      release_id
      title
    }
    container_name
    context {
      action_id
      agent_config_id
      agent_id
      agent_thread_id
      instance_id
      pathway_id
      run_id
      step_id
      track_id
    }
    date
    expires_at
    form {
      definition_id
      id
      key
      metadata
      previous_answers {
        activity_id
        date
      }
      questions {
        dataPointValueType
        definition_id
        id
        key
        metadata
        page
        questionType
        title
        title_html
        userQuestionType
      }
      release_id
      title
      trademark
    }
    form_display_mode
    icon_url
    id
    isUserActivity
    metadata
    public
    reference_id
    reference_type
    resolution
    session_id
    status
    stream_id
  }
}

Variables:

{
  "only_stakeholder_activities": true
}

`sessionCompleted`

Emits when a hosted session is completed.

Returns: HostedSession!

Example

subscription SessionCompleted {
  sessionCompleted {
    cancel_url
    created_at
    expires_at
    id
    organization_slug
    pathway_id
    stakeholder {
      id
      name
      type
    }
    status
    success_url
    tracking {
      custom
      utm_campaign
      utm_content
      utm_medium
      utm_source
      utm_term
    }
    user_context {
      stytch_member_email
      stytch_member_id
    }
  }
}

`sessionExpired`

Emits when a hosted session expires.

Returns: HostedSession!

Example

subscription SessionExpired {
  sessionExpired {
    cancel_url
    created_at
    expires_at
    id
    organization_slug
    pathway_id
    stakeholder {
      id
      name
      type
    }
    status
    success_url
    tracking {
      custom
      utm_campaign
      utm_content
      utm_medium
      utm_source
      utm_term
    }
    user_context {
      stytch_member_email
      stytch_member_id
    }
  }
}

`webhookCallCreated`

Emits when a webhook call is created.

Arguments

Argument	Type	Required	Description
`pathway_id`	`String!`	Yes	The ID of the care flow

Returns: WebhookCall!

Example

subscription WebhookCallCreated($pathway_id: String!) {
  webhookCallCreated(pathway_id: $pathway_id) {
    created_at
    event_type
    id
    pathway {
      id
      pathway_definition_id
      patient_id
      start_date
    }
    request {
      body
      endpoint
      headers {
        key
        value
      }
      method
    }
    responses {
      body
      date
      status
    }
    status
    webhook_id
    webhook_name
  }
}

Variables:

{
  "pathway_id": "<string>"
}

`webhookCallUpdated`

Emits when a webhook call is updated.

Arguments

Argument	Type	Required	Description
`pathway_id`	`String!`	Yes	The ID of the care flow

Returns: WebhookCall!

Example

subscription WebhookCallUpdated($pathway_id: String!) {
  webhookCallUpdated(pathway_id: $pathway_id) {
    created_at
    event_type
    id
    pathway {
      id
      pathway_definition_id
      patient_id
      start_date
    }
    request {
      body
      endpoint
      headers {
        key
        value
      }
      method
    }
    responses {
      body
      date
      status
    }
    status
    webhook_id
    webhook_name
  }
}

Variables:

{
  "pathway_id": "<string>"
}

Subscriptions

On this page