{
  "$result_object_key": [
    {
      "api_url": "https://api.sprucehealth.com/v1/conversations/conv_12345",
      "app_url": "https://app.sprucehealth.com/conversations/conv_12345",
      "archived": null,
      "assigned_to_member_id": "member_67890",
      "associated_contact_ids": [],
      "contact_id": "entity_0E5QDGJC03000",
      "conversation_type": "sms",
      "created_at": "2025-02-11T08:22:10Z",
      "external_participants": [
        {
          "contact": null,
          "display_names": "John Doe",
          "endpoint": {
            "channel": "sms",
            "display_value": "(555) 123-4567",
            "endpoint_id": null,
            "is_internal": null,
            "labels": "mobile",
            "object": "endpoint",
            "raw_value": {
              "email": "patient@example.com",
              "phone": "+15551231234",
              "value": "secure_channel_id"
            }
          }
        }
      ],
      "id": "conv_12345",
      "internal_endpoint": {
        "channel": "sms",
        "display_value": "(555) 123-4567",
        "endpoint_id": null,
        "is_internal": null,
        "labels": "mobile",
        "object": "endpoint",
        "raw_value": {
          "email": "patient@example.com",
          "phone": "+15551231234",
          "value": "secure_channel_id"
        }
      },
      "internal_member_ids": [],
      "is_read_only": null,
      "last_message_at": "2025-02-11T08:22:10Z",
      "object": "conversation",
      "subtitle": "Follow-up discussion",
      "tags": [
        {
          "id": "tag_0E5QDGJC03000",
          "value": "high-priority"
        }
      ],
      "title": "Patient Check-in"
    }
  ]
}

{
  "$result_object_key": [
    {
      "api_url": "API URL for this conversation.",
      "app_url": "App URL for this conversation.",
      "archived": "Whether this conversation is archived.",
      "assigned_to_member_id": "ID of the member assigned to this conversation.",
      "associated_contact_ids": "Contact IDs associated with this conversation.",
      "contact_id": "Unique identifier for the contact in the Spruce system that is the external participant in this conversation",
      "conversation_type": "Type of conversation (sms, email, etc.).",
      "created_at": "Timestamp when the conversation was created.",
      "external_participants": {
        "contact": "Contact ID of the external participant.",
        "display_names": "Display names for the external participant.",
        "endpoint": {
          "channel": "Communication channel type.",
          "display_value": "Human-readable display value.",
          "endpoint_id": "Unique identifier for the endpoint.",
          "is_internal": "Whether this is an internal endpoint.",
          "labels": "Labels associated with the endpoint.",
          "object": "Object type identifier.",
          "raw_value": {
            "email": "Email address value.",
            "phone": "Phone number value.",
            "value": "Secure channel identifier."
          }
        }
      },
      "id": "Unique identifier for the conversation in the Spruce system.",
      "internal_endpoint": {
        "channel": "Communication channel type.",
        "display_value": "Human-readable display value.",
        "endpoint_id": "Unique identifier for the endpoint.",
        "is_internal": "Whether this is an internal endpoint.",
        "labels": "Labels associated with the endpoint.",
        "object": "Object type identifier.",
        "raw_value": {
          "email": "Email address value.",
          "phone": "Phone number value.",
          "value": "Secure channel identifier."
        }
      },
      "internal_member_ids": "Internal member IDs participating in this conversation.",
      "is_read_only": "Whether this conversation is read-only.",
      "last_message_at": "Timestamp of the last message in this conversation.",
      "object": "Object type identifier.",
      "subtitle": "Subtitle for the conversation.",
      "tags": {
        "id": "Unique identifier for the tag.",
        "value": "Tag value."
      },
      "title": "Title of the conversation."
    }
  ]
}

{
  "$result_object_key": [
    {
      "api_url": "https://api.sprucehealth.com/v1/conversations/conv_12345",
      "app_url": "https://app.sprucehealth.com/conversations/conv_12345",
      "archived": null,
      "assigned_to_member_id": "member_67890",
      "associated_contact_ids": [],
      "contact_id": "entity_0E5QDGJC03000",
      "conversation_type": "sms",
      "created_at": "2025-02-11T08:22:10Z",
      "external_participants": [
        {
          "contact": null,
          "display_names": "John Doe",
          "endpoint": {
            "channel": "sms",
            "display_value": "(555) 123-4567",
            "endpoint_id": null,
            "is_internal": null,
            "labels": "mobile",
            "object": "endpoint",
            "raw_value": {
              "email": "patient@example.com",
              "phone": "+15551231234",
              "value": "secure_channel_id"
            }
          }
        }
      ],
      "id": "conv_12345",
      "internal_endpoint": {
        "channel": "sms",
        "display_value": "(555) 123-4567",
        "endpoint_id": null,
        "is_internal": null,
        "labels": "mobile",
        "object": "endpoint",
        "raw_value": {
          "email": "patient@example.com",
          "phone": "+15551231234",
          "value": "secure_channel_id"
        }
      },
      "internal_member_ids": [],
      "is_read_only": null,
      "last_message_at": "2025-02-11T08:22:10Z",
      "object": "conversation",
      "subtitle": "Follow-up discussion",
      "tags": [
        {
          "id": "tag_0E5QDGJC03000",
          "value": "high-priority"
        }
      ],
      "title": "Patient Check-in"
    }
  ]
}

{
  "$result_object_key": [
    {
      "api_url": "API URL for this conversation.",
      "app_url": "App URL for this conversation.",
      "archived": "Whether this conversation is archived.",
      "assigned_to_member_id": "ID of the member assigned to this conversation.",
      "associated_contact_ids": "Contact IDs associated with this conversation.",
      "contact_id": "Unique identifier for the contact in the Spruce system that is the external participant in this conversation",
      "conversation_type": "Type of conversation (sms, email, etc.).",
      "created_at": "Timestamp when the conversation was created.",
      "external_participants": {
        "contact": "Contact ID of the external participant.",
        "display_names": "Display names for the external participant.",
        "endpoint": {
          "channel": "Communication channel type.",
          "display_value": "Human-readable display value.",
          "endpoint_id": "Unique identifier for the endpoint.",
          "is_internal": "Whether this is an internal endpoint.",
          "labels": "Labels associated with the endpoint.",
          "object": "Object type identifier.",
          "raw_value": {
            "email": "Email address value.",
            "phone": "Phone number value.",
            "value": "Secure channel identifier."
          }
        }
      },
      "id": "Unique identifier for the conversation in the Spruce system.",
      "internal_endpoint": {
        "channel": "Communication channel type.",
        "display_value": "Human-readable display value.",
        "endpoint_id": "Unique identifier for the endpoint.",
        "is_internal": "Whether this is an internal endpoint.",
        "labels": "Labels associated with the endpoint.",
        "object": "Object type identifier.",
        "raw_value": {
          "email": "Email address value.",
          "phone": "Phone number value.",
          "value": "Secure channel identifier."
        }
      },
      "internal_member_ids": "Internal member IDs participating in this conversation.",
      "is_read_only": "Whether this conversation is read-only.",
      "last_message_at": "Timestamp of the last message in this conversation.",
      "object": "Object type identifier.",
      "subtitle": "Subtitle for the conversation.",
      "tags": {
        "id": "Unique identifier for the tag.",
        "value": "Tag value."
      },
      "title": "Title of the conversation."
    }
  ]
}

Parameters

Hide parameters

string

ID This field maps to the destination API id field.

{
  "$result_object_key": [
    {
      "api_url": "https://api.sprucehealth.com/v1/conversations/conv_12345",
      "app_url": "https://app.sprucehealth.com/conversations/conv_12345",
      "archived": null,
      "assigned_to_member_id": "member_67890",
      "associated_contact_ids": [],
      "contact_id": "entity_0E5QDGJC03000",
      "conversation_type": "sms",
      "created_at": "2025-02-11T08:22:10Z",
      "external_participants": [
        {
          "contact": null,
          "display_names": "John Doe",
          "endpoint": {
            "channel": "sms",
            "display_value": "(555) 123-4567",
            "endpoint_id": null,
            "is_internal": null,
            "labels": "mobile",
            "object": "endpoint",
            "raw_value": {
              "email": "patient@example.com",
              "phone": "+15551231234",
              "value": "secure_channel_id"
            }
          }
        }
      ],
      "id": "conv_12345",
      "internal_endpoint": {
        "channel": "sms",
        "display_value": "(555) 123-4567",
        "endpoint_id": null,
        "is_internal": null,
        "labels": "mobile",
        "object": "endpoint",
        "raw_value": {
          "email": "patient@example.com",
          "phone": "+15551231234",
          "value": "secure_channel_id"
        }
      },
      "internal_member_ids": [],
      "is_read_only": null,
      "last_message_at": "2025-02-11T08:22:10Z",
      "object": "conversation",
      "subtitle": "Follow-up discussion",
      "tags": [
        {
          "id": "tag_0E5QDGJC03000",
          "value": "high-priority"
        }
      ],
      "title": "Patient Check-in"
    }
  ]
}

{
  "$result_object_key": [
    {
      "api_url": "API URL for this conversation.",
      "app_url": "App URL for this conversation.",
      "archived": "Whether this conversation is archived.",
      "assigned_to_member_id": "ID of the member assigned to this conversation.",
      "associated_contact_ids": "Contact IDs associated with this conversation.",
      "contact_id": "Unique identifier for the contact in the Spruce system that is the external participant in this conversation",
      "conversation_type": "Type of conversation (sms, email, etc.).",
      "created_at": "Timestamp when the conversation was created.",
      "external_participants": {
        "contact": "Contact ID of the external participant.",
        "display_names": "Display names for the external participant.",
        "endpoint": {
          "channel": "Communication channel type.",
          "display_value": "Human-readable display value.",
          "endpoint_id": "Unique identifier for the endpoint.",
          "is_internal": "Whether this is an internal endpoint.",
          "labels": "Labels associated with the endpoint.",
          "object": "Object type identifier.",
          "raw_value": {
            "email": "Email address value.",
            "phone": "Phone number value.",
            "value": "Secure channel identifier."
          }
        }
      },
      "id": "Unique identifier for the conversation in the Spruce system.",
      "internal_endpoint": {
        "channel": "Communication channel type.",
        "display_value": "Human-readable display value.",
        "endpoint_id": "Unique identifier for the endpoint.",
        "is_internal": "Whether this is an internal endpoint.",
        "labels": "Labels associated with the endpoint.",
        "object": "Object type identifier.",
        "raw_value": {
          "email": "Email address value.",
          "phone": "Phone number value.",
          "value": "Secure channel identifier."
        }
      },
      "internal_member_ids": "Internal member IDs participating in this conversation.",
      "is_read_only": "Whether this conversation is read-only.",
      "last_message_at": "Timestamp of the last message in this conversation.",
      "object": "Object type identifier.",
      "subtitle": "Subtitle for the conversation.",
      "tags": {
        "id": "Unique identifier for the tag.",
        "value": "Tag value."
      },
      "title": "Title of the conversation."
    }
  ]
}

Result Object Field Details

You can use the result of the action’s data as inputs to downstream workflow actions. Each fetch action requires an object name, which nests the action’s result data inside the downstream data context in the workflow. See Passing Data Between Actions for how to set it and reference the result from downstream nodes. Here we demonstrate how to refer to this data using the prefix $result_object_key.

Fetch Action Response Object

Hide fields

string

required

ID Unique identifier for the conversation in the Spruce system.

CEL

$result_object_key[*].id

Example

"conv_12345"

string

required

ID Unique identifier for the contact in the Spruce system that is the external participant in this conversation

CEL

$result_object_key[*].contact_id

Example

"entity_0E5QDGJC03000"

string

API URL for this conversation.

CEL

$result_object_key[*].api_url

Example

"https://api.sprucehealth.com/v1/conversations/conv_12345"

string

App URL for this conversation.

CEL

$result_object_key[*].app_url

Example

"https://app.sprucehealth.com/conversations/conv_12345"

bool

required

Whether this conversation is archived.

CEL

$result_object_key[*].archived

Example

null

string

ID ID of the member assigned to this conversation.

CEL

$result_object_key[*].assigned_to_member_id

Example

"member_67890"

[]string

required

ID Contact IDs associated with this conversation.

CEL

$result_object_key[*].associated_contact_ids

Example

[]

timing.v1.Timestamp

required

Timestamp when the conversation was created.

CEL

$result_object_key[*].created_at

Example

"2025-02-11T08:22:10Z"

[]object

required

External participants in the conversation.

CEL

$result_object_key[*].external_participants

Example

[
{
"contact": null,
"display_names": "John Doe",
"endpoint": {
"channel": "sms",
"display_value": "(555) 123-4567",
"endpoint_id": null,
"is_internal": null,
"labels": "mobile",
"object": "endpoint",
"raw_value": {
  "email": "patient@example.com",
  "phone": "+15551231234",
  "value": "secure_channel_id"
}
}
}
]

[]string

required

ID Mapped array of: Contact ID of the external participant.

CEL

$result_object_key[*].external_participants.map(x, x.contact)

Example

[
null
]

[]bool

required

PII Mapped array of: Display names for the external participant.

CEL

$result_object_key[*].external_participants.map(x, x.display_names)

Example

[
"John Doe"
]

[]bool

required

Mapped array of: Communication endpoint for the participant.

CEL

$result_object_key[*].external_participants.map(x, x.endpoint)

Example

[
{
"channel": "sms",
"display_value": "(555) 123-4567",
"endpoint_id": null,
"is_internal": null,
"labels": "mobile",
"object": "endpoint",
"raw_value": {
"email": "patient@example.com",
"phone": "+15551231234",
"value": "secure_channel_id"
}
}
]

object

Internal endpoint for the conversation.

CEL

$result_object_key[*].internal_endpoint

Example

{
"channel": "sms",
"display_value": "(555) 123-4567",
"endpoint_id": null,
"is_internal": null,
"labels": "mobile",
"object": "endpoint",
"raw_value": {
"email": "patient@example.com",
"phone": "+15551231234",
"value": "secure_channel_id"
}
}

string

Communication channel type.

CEL

$result_object_key[*].internal_endpoint.channel

Example

"sms"

string

Human-readable display value.

CEL

$result_object_key[*].internal_endpoint.display_value

Example

"(555) 123-4567"

string

ID Unique identifier for the endpoint.

CEL

$result_object_key[*].internal_endpoint.endpoint_id

Example

null

bool

Whether this is an internal endpoint.

CEL

$result_object_key[*].internal_endpoint.is_internal

Example

null

[]string

Labels associated with the endpoint.

CEL

$result_object_key[*].internal_endpoint.labels

Example

"mobile"

string

Object type identifier.

CEL

$result_object_key[*].internal_endpoint.object

Example

"endpoint"

object

Raw endpoint value with type-specific data.

CEL

$result_object_key[*].internal_endpoint.raw_value

Example

{
"email": "patient@example.com",
"phone": "+15551231234",
"value": "secure_channel_id"
}

string

PII Email address value.

CEL

$result_object_key[*].internal_endpoint.raw_value.email

Example

"patient@example.com"

string

PII Phone number value.

CEL

$result_object_key[*].internal_endpoint.raw_value.phone

Example

"+15551231234"

string

PII Secure channel identifier.

CEL

$result_object_key[*].internal_endpoint.raw_value.value

Example

"secure_channel_id"

[]string

required

ID Internal member IDs participating in this conversation.

CEL

$result_object_key[*].internal_member_ids

Example

[]

bool

required

Whether this conversation is read-only.

CEL

$result_object_key[*].is_read_only

Example

null

timing.v1.Timestamp

Timestamp of the last message in this conversation.

CEL

$result_object_key[*].last_message_at

Example

"2025-02-11T08:22:10Z"

string

required

Object type identifier.

CEL

$result_object_key[*].object

Example

"conversation"

string

Subtitle for the conversation.

CEL

$result_object_key[*].subtitle

Example

"Follow-up discussion"

[]object

required

Tags associated with the conversation.

CEL

$result_object_key[*].tags

Example

[
{
"id": "tag_0E5QDGJC03000",
"value": "high-priority"
}
]

[]string

required

ID Mapped array of: Unique identifier for the tag.

CEL

$result_object_key[*].tags.map(x, x.id)

Example

[
"tag_0E5QDGJC03000"
]

[]string

required

Mapped array of: Tag value.

CEL

$result_object_key[*].tags.map(x, x.value)

Example

[
"high-priority"
]

string

Title of the conversation.

CEL

$result_object_key[*].title

Example

"Patient Check-in"

string

Type of conversation (sms, email, etc.).

CEL

$result_object_key[*].conversation_type

Example

"sms"

Events

Actions

List Conversations

Parameters

Result Object Field Details

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details