Skip to main content
images/spruce.svg

Events

Triggering Webhook Types

The following event types are associated with the Conversation event payload from Spruce.
  • Spruce Conversation Created
  • Spruce Conversation Updated
  • Spruce Conversation Deleted
{
  "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": null,
  "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": null,
  "object": "conversation",
  "subtitle": "Follow-up discussion",
  "tags": [
    {
      "id": "tag_0E5QDGJC03000",
      "value": "high-priority"
    }
  ],
  "title": "Patient Check-in"
}
{
  "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

Conversation
Event Payload