{ "api_url": "API URL for this conversation item.", "app_url": "App URL for this conversation item.", "attachments": { "data": { "mime_type": "MIME type of the attachment.", "signed_url": { "expires_at": "Timestamp when the signed URL expires.", "url": "The signed URL." } }, "title": "Title of the attachment." }, "author": { "device_information": { "access_id": "Access ID for the device.", "app_version": "App version used.", "device": "Device type.", "device_id": "Unique device identifier.", "device_model": "Device model.", "platform": "Platform (iOS, Android, web, etc.)." }, "display_name": "Display name of the author." }, "buttons": { "id": "Unique identifier for the button.", "state": "Current state of the button.", "text": "Text displayed on the button." }, "can_delete": "Whether this conversation item can be deleted.", "contact": { "api_url": "API URL for this contact.", "app_url": "App URL for this contact.", "can_delete": "Whether this contact can be deleted.", "can_edit": "Whether this contact can be edited.", "category": "Contact category.", "company_name": "Company name associated with the contact.", "created_at": "Timestamp when the contact was created.", "custom_contact_fields": { "id": "Unique identifier for the custom field.", "name": "Name of the custom field.", "value": "Value of the custom field." }, "date_of_birth": "Date of birth", "deleted_contact_ids": "Prior contact IDs merged into this Contact (note: they are deleted post-merge)", "display_name": "Display name for the contact.", "email_addresses": { "id": "Unique identifier for the email address.", "label": "Label for the email address.", "value": "Email address value." }, "fax_numbers": { "display_value": "Formatted display value for the phone number.", "id": "Unique identifier for the phone number.", "label": "Label for the phone number.", "value": "Phone number value." }, "first_name": "Given name (first name) of the contact.", "gender": "Gender of the contact.", "gender_detail": "Additional gender details.", "has_account": "Whether the contact has a Spruce account.", "has_pending_invite": "Whether the contact has a pending invitation to Spruce.", "id": "Unique identifier for the contact in the Spruce system.", "integration_links": { "contact_id": "Contact ID in Spruce.", "external_id": "External system identifier.", "integration_type": "Type of integration.", "url": "URL to the external system." }, "internal_member_ids": "Internal member IDs associated with this contact.", "last_name": "Family name (last name) of the contact.", "middle_name": "Middle name of the contact.", "object": "Object type identifier.", "organization_contact_fields": { "id": "Unique identifier for the organization field.", "name": "Name of the organization field.", "value": "Value of the organization field." }, "phone_numbers": { "display_value": "Formatted display value for the phone number.", "id": "Unique identifier for the phone number.", "label": "Label for the phone number.", "value": "Phone number value." }, "pronouns": "Preferred pronouns of the contact.", "tags": { "id": "Unique identifier for the tag.", "value": "Tag value." } }, "contact_id": "Unique identifier for the contact in the Spruce system that is the external participant in this conversation, note: only present if the contact is present on the conversation", "conversation_id": "ID of the conversation this item belongs to.", "created_at": "Timestamp when the conversation item was created.", "event": { "data": { "answered": "Whether the call was answered.", "answered_by": { "external_number": "External phone number of the party.", "line_id": "Line ID used for the call.", "teammate_id": "Teammate ID if this is an internal party." }, "duration": "Duration of the call in seconds.", "failed": "Whether the call failed.", "initiated_by": { "external_number": "External phone number of the party.", "line_id": "Line ID used for the call.", "teammate_id": "Teammate ID if this is an internal party." }, "recordings": { "mime_type": "MIME type of the attachment.", "signed_url": { "expires_at": "Timestamp when the signed URL expires.", "url": "The signed URL." } }, "spam": "Whether the call was marked as spam.", "voicemail": { "mime_type": "MIME type of the attachment.", "signed_url": { "expires_at": "Timestamp when the signed URL expires.", "url": "The signed URL." } } }, "type": "The event type" }, "external_participant": { "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 item in the Spruce system.", "is_internal_note": "Whether this is an internal note (not visible to patients).", "modified_at": "Timestamp when the conversation item was last modified.", "object": "Object type identifier.", "pages": { "id": "Unique identifier for the page.", "member_id": "Member ID associated with the page.", "resolved": "Whether the page has been resolved.", "resolved_at": "Timestamp when the page was resolved.", "resolved_by_member_id": "Member ID who resolved the page." }, "request_id": "Request ID associated with this conversation item.", "text": "Text content of the conversation item."}
Spruce
Conversation Item
Event payload details and trigger documentation for Conversation Item data from Spruce
{ "api_url": "API URL for this conversation item.", "app_url": "App URL for this conversation item.", "attachments": { "data": { "mime_type": "MIME type of the attachment.", "signed_url": { "expires_at": "Timestamp when the signed URL expires.", "url": "The signed URL." } }, "title": "Title of the attachment." }, "author": { "device_information": { "access_id": "Access ID for the device.", "app_version": "App version used.", "device": "Device type.", "device_id": "Unique device identifier.", "device_model": "Device model.", "platform": "Platform (iOS, Android, web, etc.)." }, "display_name": "Display name of the author." }, "buttons": { "id": "Unique identifier for the button.", "state": "Current state of the button.", "text": "Text displayed on the button." }, "can_delete": "Whether this conversation item can be deleted.", "contact": { "api_url": "API URL for this contact.", "app_url": "App URL for this contact.", "can_delete": "Whether this contact can be deleted.", "can_edit": "Whether this contact can be edited.", "category": "Contact category.", "company_name": "Company name associated with the contact.", "created_at": "Timestamp when the contact was created.", "custom_contact_fields": { "id": "Unique identifier for the custom field.", "name": "Name of the custom field.", "value": "Value of the custom field." }, "date_of_birth": "Date of birth", "deleted_contact_ids": "Prior contact IDs merged into this Contact (note: they are deleted post-merge)", "display_name": "Display name for the contact.", "email_addresses": { "id": "Unique identifier for the email address.", "label": "Label for the email address.", "value": "Email address value." }, "fax_numbers": { "display_value": "Formatted display value for the phone number.", "id": "Unique identifier for the phone number.", "label": "Label for the phone number.", "value": "Phone number value." }, "first_name": "Given name (first name) of the contact.", "gender": "Gender of the contact.", "gender_detail": "Additional gender details.", "has_account": "Whether the contact has a Spruce account.", "has_pending_invite": "Whether the contact has a pending invitation to Spruce.", "id": "Unique identifier for the contact in the Spruce system.", "integration_links": { "contact_id": "Contact ID in Spruce.", "external_id": "External system identifier.", "integration_type": "Type of integration.", "url": "URL to the external system." }, "internal_member_ids": "Internal member IDs associated with this contact.", "last_name": "Family name (last name) of the contact.", "middle_name": "Middle name of the contact.", "object": "Object type identifier.", "organization_contact_fields": { "id": "Unique identifier for the organization field.", "name": "Name of the organization field.", "value": "Value of the organization field." }, "phone_numbers": { "display_value": "Formatted display value for the phone number.", "id": "Unique identifier for the phone number.", "label": "Label for the phone number.", "value": "Phone number value." }, "pronouns": "Preferred pronouns of the contact.", "tags": { "id": "Unique identifier for the tag.", "value": "Tag value." } }, "contact_id": "Unique identifier for the contact in the Spruce system that is the external participant in this conversation, note: only present if the contact is present on the conversation", "conversation_id": "ID of the conversation this item belongs to.", "created_at": "Timestamp when the conversation item was created.", "event": { "data": { "answered": "Whether the call was answered.", "answered_by": { "external_number": "External phone number of the party.", "line_id": "Line ID used for the call.", "teammate_id": "Teammate ID if this is an internal party." }, "duration": "Duration of the call in seconds.", "failed": "Whether the call failed.", "initiated_by": { "external_number": "External phone number of the party.", "line_id": "Line ID used for the call.", "teammate_id": "Teammate ID if this is an internal party." }, "recordings": { "mime_type": "MIME type of the attachment.", "signed_url": { "expires_at": "Timestamp when the signed URL expires.", "url": "The signed URL." } }, "spam": "Whether the call was marked as spam.", "voicemail": { "mime_type": "MIME type of the attachment.", "signed_url": { "expires_at": "Timestamp when the signed URL expires.", "url": "The signed URL." } } }, "type": "The event type" }, "external_participant": { "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 item in the Spruce system.", "is_internal_note": "Whether this is an internal note (not visible to patients).", "modified_at": "Timestamp when the conversation item was last modified.", "object": "Object type identifier.", "pages": { "id": "Unique identifier for the page.", "member_id": "Member ID associated with the page.", "resolved": "Whether the page has been resolved.", "resolved_at": "Timestamp when the page was resolved.", "resolved_by_member_id": "Member ID who resolved the page." }, "request_id": "Request ID associated with this conversation item.", "text": "Text content of the conversation item."}
Events
Triggering Webhook Types
The following event types are associated with the Conversation Item event payload from Spruce.
{ "api_url": "API URL for this conversation item.", "app_url": "App URL for this conversation item.", "attachments": { "data": { "mime_type": "MIME type of the attachment.", "signed_url": { "expires_at": "Timestamp when the signed URL expires.", "url": "The signed URL." } }, "title": "Title of the attachment." }, "author": { "device_information": { "access_id": "Access ID for the device.", "app_version": "App version used.", "device": "Device type.", "device_id": "Unique device identifier.", "device_model": "Device model.", "platform": "Platform (iOS, Android, web, etc.)." }, "display_name": "Display name of the author." }, "buttons": { "id": "Unique identifier for the button.", "state": "Current state of the button.", "text": "Text displayed on the button." }, "can_delete": "Whether this conversation item can be deleted.", "contact": { "api_url": "API URL for this contact.", "app_url": "App URL for this contact.", "can_delete": "Whether this contact can be deleted.", "can_edit": "Whether this contact can be edited.", "category": "Contact category.", "company_name": "Company name associated with the contact.", "created_at": "Timestamp when the contact was created.", "custom_contact_fields": { "id": "Unique identifier for the custom field.", "name": "Name of the custom field.", "value": "Value of the custom field." }, "date_of_birth": "Date of birth", "deleted_contact_ids": "Prior contact IDs merged into this Contact (note: they are deleted post-merge)", "display_name": "Display name for the contact.", "email_addresses": { "id": "Unique identifier for the email address.", "label": "Label for the email address.", "value": "Email address value." }, "fax_numbers": { "display_value": "Formatted display value for the phone number.", "id": "Unique identifier for the phone number.", "label": "Label for the phone number.", "value": "Phone number value." }, "first_name": "Given name (first name) of the contact.", "gender": "Gender of the contact.", "gender_detail": "Additional gender details.", "has_account": "Whether the contact has a Spruce account.", "has_pending_invite": "Whether the contact has a pending invitation to Spruce.", "id": "Unique identifier for the contact in the Spruce system.", "integration_links": { "contact_id": "Contact ID in Spruce.", "external_id": "External system identifier.", "integration_type": "Type of integration.", "url": "URL to the external system." }, "internal_member_ids": "Internal member IDs associated with this contact.", "last_name": "Family name (last name) of the contact.", "middle_name": "Middle name of the contact.", "object": "Object type identifier.", "organization_contact_fields": { "id": "Unique identifier for the organization field.", "name": "Name of the organization field.", "value": "Value of the organization field." }, "phone_numbers": { "display_value": "Formatted display value for the phone number.", "id": "Unique identifier for the phone number.", "label": "Label for the phone number.", "value": "Phone number value." }, "pronouns": "Preferred pronouns of the contact.", "tags": { "id": "Unique identifier for the tag.", "value": "Tag value." } }, "contact_id": "Unique identifier for the contact in the Spruce system that is the external participant in this conversation, note: only present if the contact is present on the conversation", "conversation_id": "ID of the conversation this item belongs to.", "created_at": "Timestamp when the conversation item was created.", "event": { "data": { "answered": "Whether the call was answered.", "answered_by": { "external_number": "External phone number of the party.", "line_id": "Line ID used for the call.", "teammate_id": "Teammate ID if this is an internal party." }, "duration": "Duration of the call in seconds.", "failed": "Whether the call failed.", "initiated_by": { "external_number": "External phone number of the party.", "line_id": "Line ID used for the call.", "teammate_id": "Teammate ID if this is an internal party." }, "recordings": { "mime_type": "MIME type of the attachment.", "signed_url": { "expires_at": "Timestamp when the signed URL expires.", "url": "The signed URL." } }, "spam": "Whether the call was marked as spam.", "voicemail": { "mime_type": "MIME type of the attachment.", "signed_url": { "expires_at": "Timestamp when the signed URL expires.", "url": "The signed URL." } } }, "type": "The event type" }, "external_participant": { "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 item in the Spruce system.", "is_internal_note": "Whether this is an internal note (not visible to patients).", "modified_at": "Timestamp when the conversation item was last modified.", "object": "Object type identifier.", "pages": { "id": "Unique identifier for the page.", "member_id": "Member ID associated with the page.", "resolved": "Whether the page has been resolved.", "resolved_at": "Timestamp when the page was resolved.", "resolved_by_member_id": "Member ID who resolved the page." }, "request_id": "Request ID associated with this conversation item.", "text": "Text content of the conversation item."}
Payload Field Details
Event Payload
Hide fields
string
required
ID Unique identifier for the conversation item in the Spruce system.
CEL
id
Example
"item_12345"
string
ID Unique identifier for the contact in the Spruce system that is the external participant in this conversation, note: only present if the contact is present on the conversation