{ "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."}
Spruce
Conversation
Event payload details and trigger documentation for Conversation data from Spruce
{ "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."}
Events
Triggering Webhook Types
The following event types are associated with the Conversation event payload from Spruce.
{ "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."}
Payload Field Details
Event Payload
Hide fields
string
required
ID Unique identifier for the conversation in the Spruce system.
CEL
id
Example
"conv_12345"
string
required
ID Unique identifier for the contact in the Spruce system that is the external participant in this conversation