Events
Triggering Webhook Types
The following event types are associated with the Contact event payload from Spruce.Spruce Contact CreatedSpruce Contact UpdatedSpruce Contact Deleted
Copy
Ask AI
{
"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"
}
]
}
Copy
Ask AI
{
"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
Hide fields
Hide fields
ID Unique identifier for the contact in the Spruce system.CEL
Copy
Ask AI
id
Example
Copy
Ask AI
"entity_0E5QDGJC03000"
API URL for this contact.
CEL
Copy
Ask AI
api_url
Example
Copy
Ask AI
"https://api.sprucehealth.com/v1/contacts/contact_12345"
App URL for this contact.
CEL
Copy
Ask AI
app_url
Example
Copy
Ask AI
"https://app.sprucehealth.com/contacts/contact_12345"
Whether this contact can be deleted.
CEL
Copy
Ask AI
can_delete
Example
Copy
Ask AI
null
Whether this contact can be edited.
CEL
Copy
Ask AI
can_edit
Example
Copy
Ask AI
null
Contact category.
CEL
Copy
Ask AI
category
Example
Copy
Ask AI
spruce.v1.ContactCategory.CONTACT_CATEGORY_PATIENT
spruce.v1.ContactCategory.CONTACT_CATEGORY_PROFESSIONAL
spruce.v1.ContactCategory.CONTACT_CATEGORY_CLINIC
PII Company name associated with the contact.CEL
Copy
Ask AI
company_name
Example
Copy
Ask AI
"ACME Healthcare"
Timestamp when the contact was created.
CEL
Copy
Ask AI
created_at
Example
Copy
Ask AI
null
Custom contact fields defined by the organization.
CEL
Copy
Ask AI
custom_contact_fields
Example
Copy
Ask AI
[
{
"id": "entityCustomField_0E5QDGJC03000",
"name": "Insurance Provider",
"value": "Blue Cross Blue Shield"
}
]
ID Mapped array of: Unique identifier for the custom field.CEL
Copy
Ask AI
custom_contact_fields.map(x, x.id)
Example
Copy
Ask AI
[
"entityCustomField_0E5QDGJC03000"
]
Mapped array of: Name of the custom field.
CEL
Copy
Ask AI
custom_contact_fields.map(x, x.name)
Example
Copy
Ask AI
[
"Insurance Provider"
]
PII Mapped array of: Value of the custom field.CEL
Copy
Ask AI
custom_contact_fields.map(x, x.value)
Example
Copy
Ask AI
[
"Blue Cross Blue Shield"
]
HI Date of birthCEL
Copy
Ask AI
date_of_birth
Example
Copy
Ask AI
"1990-01-15"
PII Display name for the contact.CEL
Copy
Ask AI
display_name
Example
Copy
Ask AI
"John Doe"
Email addresses associated with the contact.
CEL
Copy
Ask AI
email_addresses
Example
Copy
Ask AI
[
{
"id": "entityContact_26RRC7PQ6JG00",
"label": "primary",
"value": "john.doe@example.com"
}
]
ID Mapped array of: Unique identifier for the email address.CEL
Copy
Ask AI
email_addresses.map(x, x.id)
Example
Copy
Ask AI
[
"entityContact_26RRC7PQ6JG00"
]
Mapped array of: Label for the email address.
CEL
Copy
Ask AI
email_addresses.map(x, x.label)
Example
Copy
Ask AI
[
"primary"
]
PII Mapped array of: Email address value.CEL
Copy
Ask AI
email_addresses.map(x, x.value)
Example
Copy
Ask AI
[
"john.doe@example.com"
]
PII Family name (last name) of the contact.CEL
Copy
Ask AI
last_name
Example
Copy
Ask AI
"Doe"
Fax numbers associated with the contact.
CEL
Copy
Ask AI
fax_numbers
Example
Copy
Ask AI
[
{
"display_value": "(555) 123-4567",
"id": "entityContact_26RRC7PQ6JG00",
"label": "mobile",
"value": null
}
]
ID Mapped array of: Unique identifier for the phone number.CEL
Copy
Ask AI
fax_numbers.map(x, x.id)
Example
Copy
Ask AI
[
"entityContact_26RRC7PQ6JG00"
]
Mapped array of: Label for the phone number.
CEL
Copy
Ask AI
fax_numbers.map(x, x.label)
Example
Copy
Ask AI
[
"mobile"
]
Mapped array of: Phone number value.
CEL
Copy
Ask AI
fax_numbers.map(x, x.value)
Example
Copy
Ask AI
[
null
]
Mapped array of: Formatted display value for the phone number.
CEL
Copy
Ask AI
fax_numbers.map(x, x.display_value)
Example
Copy
Ask AI
[
"(555) 123-4567"
]
HI Gender of the contact.CEL
Copy
Ask AI
gender
Example
Copy
Ask AI
"male"
HI Additional gender details.CEL
Copy
Ask AI
gender_detail
Example
Copy
Ask AI
null
PII Given name (first name) of the contact.CEL
Copy
Ask AI
first_name
Example
Copy
Ask AI
"John"
Whether the contact has a Spruce account.
CEL
Copy
Ask AI
has_account
Example
Copy
Ask AI
null
Whether the contact has a pending invitation to Spruce.
CEL
Copy
Ask AI
has_pending_invite
Example
Copy
Ask AI
null
Links to third-party integrations.
CEL
Copy
Ask AI
integration_links
Example
Copy
Ask AI
[
{
"contact_id": "entity_0E5QDGJC03000",
"external_id": "ext_12345",
"integration_type": "epic",
"url": "https://hint.com/patient/100031277"
}
]
ID Mapped array of: Contact ID in Spruce.CEL
Copy
Ask AI
integration_links.map(x, x.contact_id)
Example
Copy
Ask AI
[
"entity_0E5QDGJC03000"
]
ID Mapped array of: External system identifier.CEL
Copy
Ask AI
integration_links.map(x, x.external_id)
Example
Copy
Ask AI
[
"ext_12345"
]
Mapped array of: Type of integration.
CEL
Copy
Ask AI
integration_links.map(x, x.integration_type)
Example
Copy
Ask AI
[
"epic"
]
ID PII Mapped array of: URL to the external system.CEL
Copy
Ask AI
integration_links.map(x, x.url)
Example
Copy
Ask AI
[
"https://hint.com/patient/100031277"
]
ID Internal member IDs associated with this contact.CEL
Copy
Ask AI
internal_member_ids
Example
Copy
Ask AI
[]
PII Middle name of the contact.CEL
Copy
Ask AI
middle_name
Example
Copy
Ask AI
"Smith"
Object type identifier.
CEL
Copy
Ask AI
object
Example
Copy
Ask AI
"contact"
Organization-specific contact fields.
CEL
Copy
Ask AI
organization_contact_fields
Example
Copy
Ask AI
[
{
"id": "managedCustomField_0E5QDGJC03000",
"name": "Patient ID",
"value": "PT12345"
}
]
ID Mapped array of: Unique identifier for the organization field.CEL
Copy
Ask AI
organization_contact_fields.map(x, x.id)
Example
Copy
Ask AI
[
"managedCustomField_0E5QDGJC03000"
]
Mapped array of: Name of the organization field.
CEL
Copy
Ask AI
organization_contact_fields.map(x, x.name)
Example
Copy
Ask AI
[
"Patient ID"
]
ID Mapped array of: Value of the organization field.CEL
Copy
Ask AI
organization_contact_fields.map(x, x.value)
Example
Copy
Ask AI
[
"PT12345"
]
Phone numbers associated with the contact.
CEL
Copy
Ask AI
phone_numbers
Example
Copy
Ask AI
[
{
"display_value": "(555) 123-4567",
"id": "entityContact_26RRC7PQ6JG00",
"label": "mobile",
"value": null
}
]
ID Mapped array of: Unique identifier for the phone number.CEL
Copy
Ask AI
phone_numbers.map(x, x.id)
Example
Copy
Ask AI
[
"entityContact_26RRC7PQ6JG00"
]
Mapped array of: Label for the phone number.
CEL
Copy
Ask AI
phone_numbers.map(x, x.label)
Example
Copy
Ask AI
[
"mobile"
]
Mapped array of: Phone number value.
CEL
Copy
Ask AI
phone_numbers.map(x, x.value)
Example
Copy
Ask AI
[
null
]
Mapped array of: Formatted display value for the phone number.
CEL
Copy
Ask AI
phone_numbers.map(x, x.display_value)
Example
Copy
Ask AI
[
"(555) 123-4567"
]
PII Preferred pronouns of the contact.CEL
Copy
Ask AI
pronouns
Example
Copy
Ask AI
"he/him"
Tags associated with the contact.
CEL
Copy
Ask AI
tags
Example
Copy
Ask AI
[
{
"id": "tag_0E5QDGJC03000",
"value": "high-priority"
}
]
ID Mapped array of: Unique identifier for the tag.CEL
Copy
Ask AI
tags.map(x, x.id)
Example
Copy
Ask AI
[
"tag_0E5QDGJC03000"
]
Mapped array of: Tag value.
CEL
Copy
Ask AI
tags.map(x, x.value)
Example
Copy
Ask AI
[
"high-priority"
]
