Skip to main content
images/spruce.svg

Events

Triggering Webhook Types

The following event types are associated with the Contact event payload from Spruce.
  • Spruce Contact Created
  • Spruce Contact Updated
  • Spruce Contact Deleted
{
  "api_url": "https://api.sprucehealth.com/v1/contacts/contact_12345",
  "app_url": "https://app.sprucehealth.com/contacts/contact_12345",
  "can_delete": null,
  "can_edit": null,
  "category": "patient",
  "company_name": "ACME Healthcare",
  "created_at": null,
  "custom_contact_fields": [
    {
      "id": "entityCustomField_0E5QDGJC03000",
      "name": "Insurance Provider",
      "value": "Blue Cross Blue Shield"
    }
  ],
  "date_of_birth": "1990-01-15",
  "display_name": "John Doe",
  "email_addresses": [
    {
      "id": "entityContact_26RRC7PQ6JG00",
      "label": "primary",
      "value": "john.doe@example.com"
    }
  ],
  "fax_numbers": [
    {
      "display_value": "(555) 123-4567",
      "id": "entityContact_26RRC7PQ6JG00",
      "label": "mobile",
      "value": null
    }
  ],
  "first_name": "John",
  "gender": "male",
  "gender_detail": null,
  "has_account": null,
  "has_pending_invite": null,
  "id": "entity_0E5QDGJC03000",
  "integration_links": [
    {
      "contact_id": "entity_0E5QDGJC03000",
      "external_id": "ext_12345",
      "integration_type": "epic",
      "url": "https://hint.com/patient/100031277"
    }
  ],
  "internal_member_ids": [],
  "last_name": "Doe",
  "middle_name": "Smith",
  "object": "contact",
  "organization_contact_fields": [
    {
      "id": "managedCustomField_0E5QDGJC03000",
      "name": "Patient ID",
      "value": "PT12345"
    }
  ],
  "phone_numbers": [
    {
      "display_value": "(555) 123-4567",
      "id": "entityContact_26RRC7PQ6JG00",
      "label": "mobile",
      "value": null
    }
  ],
  "pronouns": "he/him",
  "tags": [
    {
      "id": "tag_0E5QDGJC03000",
      "value": "high-priority"
    }
  ]
}
{
  "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",
  "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."
  }
}

Payload Field Details

Contact
Event Payload