Web hooks - additional information
Here you'll find sample payloads in case our integration partners connecting to Passare's public API and web hooks want more information before choosing which trigger events occurring in Passare should send them automated notifications.
Sample webhook payloads
Acquaintance created
{
:event_id=>"bbfaea2a-1ad4-4462-b2d5-7eff5ed1bb1c",
:trigger_type=>"acquaintance_created",
:trigger_timestamp=>Thu, 15 Sep 2022 19:19:29 +0000,
:notification_timestamp=>Thu, 15 Sep 2022 19:19:29 +0000,
:organization_id=>"1bcd7929-7e78-432b-8f3e-e2794fe8034e",
:branch_id=>"1c79ed87-dd71-43dc-9ced-2efe89d35185",
:case_uuid=>"ce56f187-4262-4892-9382-ab2ff46b86fb",
:payload=>"{
\"acquaintance_uuid\":\"8f285d78-d2ae-4e82-af62-fd09ea42e4c1\",
\"title\":null,
\"first_name\":\"Street\",
\"middle_name\":null,
\"last_name\":\"Game\",
\"last_name_at_birth\":null,
\"suffix\":null,
\"preferred_name_attribute\":null,
\"display_name\":null,
\"is_deceased\":false,
\"relationship\":\"Cousin\",
\"birth_date\":null,
\"acquaintance_types\":[
{
\"id\":3,
\"name\":\"Next of Kin\",
\"created_at\":\"2013-10-16T01:17:10.169Z\",
\"updated_at\":\"2013-10-16T01:17:10.169Z\",
\"acquaintance_type_uuid\":\"e19d6fd7-b72b-44f3-b461-ff3246f2515f\"
},
{
\"id\":1,
\"name\":\"Informant\",
\"created_at\":\"2013-10-16T01:17:10.125Z\",
\"updated_at\":\"2013-10-16T01:17:10.125Z\",
\"acquaintance_type_uuid\":\"a2305ba1-b4b6-482e-b2d9-e82d4d6142b1\"
}
],
\"spouse_acquaintance_uuid\":null,
\"address_uuid\":\"684513ab-c758-4f87-94cf-a57399898970\",
\"birth_address_uuid\":null,
\"contact_information_uuid\":\"cfb6bafc-8d28-441f-bcc8-3c2be7fe0f7c\",
\"branch_uuid\":\"a0daa794-d08d-4e9c-b460-12d3fa55921d\",
\"case_uuid\":\"258eac63-1940-41e5-9d32-d883192b1df0\"
}"
}
Acquaintance updated
{
:event_id=>"bbfaea2a-1ad4-4462-b2d5-7eff5ed1bb1c",
:trigger_type=>"acquaintance_updated",
:trigger_timestamp=>Thu, 15 Sep 2022 19:32:43 +0000,
:notification_timestamp=>Thu, 15 Sep 2022 19:32:43 +0000,
:organization_id=>"1bcd7929-7e78-432b-8f3e-e2794fe8034e",
:branch_id=>"1c79ed87-dd71-43dc-9ced-2efe89d35185",
:case_uuid=>"ce56f187-4262-4892-9382-ab2ff46b86fb",
:payload=>"{
\"acquaintance_uuid\":\"e9c709cc-fcec-4692-9bf0-9559979e7f48\",
\"title\":null,
\"first_name\":\"bbb\",
\"middle_name\":null,
\"last_name\":\"bbbb\",
\"last_name_at_birth\":null,
\"suffix\":null,
\"preferred_name_attribute\":null,
\"display_name\":null,
\"is_deceased\":false,
\"relationship\":\"Brother\",
\"birth_date\":null,
\"acquaintance_types\":[
{
\"id\":1,
\"name\":\"Informant\",
\"created_at\":\"2013-10-16T01:17:10.125Z\",
\"updated_at\":\"2013-10-16T01:17:10.125Z\",
\"acquaintance_type_uuid\":\"a2305ba1-b4b6-482e-b2d9-e82d4d6142b1\"
}
],
\"spouse_acquaintance_uuid\":null,
\"address_uuid\":\"0e9b9ef1-f503-49d3-8b11-5be06e936ddd\",
\"birth_address_uuid\":null,
\"contact_information_uuid\":\"93187dd7-1382-4f31-8742-bd0a52d11e04\",
\"branch_uuid\":\"a0daa794-d08d-4e9c-b460-12d3fa55921d\",
\"case_uuid\":\"072e229e-3684-47da-8259-5611bc124af9\"
}"
}
Case created
:event_id=>"bbfaea2a-1ad4-4462-b2d5-7eff5ed1bb1c",
:trigger_type=>"case_created",
:trigger_timestamp=>Thu, 15 Sep 2022 19:37:54 +0000,
:notification_timestamp=>Thu, 15 Sep 2022 19:37:54 +0000,
:organization_id=>"1bcd7929-7e78-432b-8f3e-e2794fe8034e",
:branch_id=>"1c79ed87-dd71-43dc-9ced-2efe89d35185",
:case_uuid=>"ce56f187-4262-4892-9382-ab2ff46b86fb",
:payload=>"{
\"branch_uuid\":\"a0daa794-d08d-4e9c-b460-12d3fa55921d\",
\"case_types\":[
\"at_need\"
],
\"decedent\":{
\"person\":{
\"first_name\":\"test\",
\"last_name\":\"p\\u0026S\"
}
},
\"case_uuid\":\"dc231fb1-eb99-4c15-bf63-ae455f54a6cd\"
}"
}
Case updated
Updated when one of the following fields changes:
-
Case status
-
Case tags
-
Decedent date of death
-
Client service type
-
Case assigned to
-
Case contract signed_at date
-
Case contract exported_on date
{
:event_id=>"bbfaea2a-1ad4-4462-b2d5-7eff5ed1bb1c",
:trigger_type=>"case_created",
:trigger_timestamp=>Thu, 15 Sep 2022 19:37:54 +0000,
:notification_timestamp=>Thu, 15 Sep 2022 19:37:54 +0000,
:organization_id=>"1bcd7929-7e78-432b-8f3e-e2794fe8034e",
:payload=>"{
\"case_uuid\":\"2ebb6ea2-162a-4518-92ba-88320bafe88b\",
\"decedent_person\":{
\"person\":{
\"decedent_uuid\":\"f5221a97-5d61-42ec-83a2-a052e5d1c5c4\",
\"title\":null,
\"first_name\":\"Ophelia\",
\"middle_name\":\"Ann\",
\"last_name\":\"Welsh\",
\"suffix\":null,
\"gender\":\"Female\",
\"birth_date\":\"1943-04-07\",
\"full_name\":\"Ophelia Ann Welsh\"},
\"address\":{
\"address_uuid\":\"00b304e8-da7c-46ff-bec5-8749dc3e635b\",
\"city\":\"Silver Spring\",
\"state\":\"MD\",
\"county\":\"Montgomery\",
\"country\":\"US\",
\"borough\":\"\",
\"township\":\"\",
\"village\":\"\",
\"other_township\":\"\",
\"identifier\":\"City\",
\"inside_city_limits\":null,
\"latitude\":0.0,
\"longitude\":0.0},
\"death\":\"2020-10-26T02:30:00.000Z\",
\"highest_rank\":null,
\"obituary\":{
\"content\":\"\\u003cp\\u003eOphelia Welsh, 77, passed away on October 26, 2020, in Silver Spring, MD. The service for Ophelia Welsh will be held on Thursday, at 11:00 AM at Rose Garden Cemetery.\\u003c/p\\u003e\\r\\n\\r\\n\\u003cp\\u003eMemorial donations can be made in Ophelia's name to First Church.\\u003c/p\\u003e\\r\\n\",
\"primary_photo\":\"https://cap.passare.com/stored_file_file/8020561.jpg\",
\"secondary_photo\":\"\",
\"locked\":true,
\"last_updated\":\"2020-10-27T13:37:04.266Z\",
\"tribute_video\":null},
\"veteran\":false},
\"decedent_animal\":null,
\"events\":[
{
\"name\":\"Memorial Service\",
\"location_name\":\"First Church\",
\"location_address\":{\"address_uuid\":\"4452296c-1d0d-4545-955c-596e0db9ab36\",\"address1\":\"123 Church St\",
\"address2\":null,
\"address3\":null,
\"address4\":null,
\"city\":\"Chicago\",
\"state\":\"IL\",
\"zip\":\"60604\",
\"county\":null,
\"country\":\"US\",
\"borough\":\"\",
\"township\":\"\",
\"village\":\"\",
\"other_township\":\"\",
\"identifier\":\"City\",
\"inside_city_limits\":null,
\"latitude\":41.6930368,
\"longitude\":-87.6642955},
\"date\":\"2020/10/31\",
\"start_time\":\"10:00:00\",
\"end_time\":\"12:00:00\",
\"event_uuid\":\"f5478783-f3df-45d7-8a8b-0d92d443132c\",
\"last_updated\":\"2025-01-27T08:54:55.733Z\",
\"public\":true,
\"livestream_url\":null,
\"has_livestream\":false
}
],
\"memorial_donations\":[
{
\"name\":\"First Church\",
\"website\":\"http://www.google.com\",
\"memorial_donation_uuid\":\"877a7c22-9753-4485-b7aa-46590d903f97\",
\"last_updated\":\"2020-10-27T13:36:14.982Z\"
}
],
\"case_identifier\":\"N/A\",
\"case_assigned_to\":null,
\"user_uuid\":null,
\"case_assigned_to_email\":null,
\"contact_information_uuid\":\"9d81a52e-b257-4d6f-b0bb-b4802c113ce1\",
\"case_types\":[\"pre_need\"],
\"custom_fields\":[
{
\"name\":\"FD User\",
\"value\":\"Mr. Bob Counselor\
}
],
\"case_url\":\"https://cap.passare.com/cases/2066260\",
\"pc_payment_link\":null,
\"client_service_type_name\":\"Cremation w/ Service\",
\"case_status\":null,
\"send_survey\":false,
\"pet_business\":null,
\"case_tags\":[],
\"branch_name\":\"Branch A\",
\"branch_uuid\":\"0123fdf3-5e2f-42e7-a0d2-f19f394ac839\",
\"created_at\":\"2020-10-27T13:26:48.948Z\"
}"
}
Obituary synced
:event_id=>"bbfaea2a-1ad4-4462-b2d5-7eff5ed1bb1c",
:trigger_type=>"obituary_synced",
:trigger_timestamp=>Thu, 15 Sep 2022 19:40:04 +0000,
:notification_timestamp=>Thu, 15 Sep 2022 19:40:04 +0000,
:organization_id=>"1bcd7929-7e78-432b-8f3e-e2794fe8034e",
:branch_id=>"1c79ed87-dd71-43dc-9ced-2efe89d35185",
:case_uuid=>"ce56f187-4262-4892-9382-ab2ff46b86fb",
:payload=>"{
\"content\":null,
\"primary_photo\":\"\",
\"secondary_photo\":\"\",
\"locked\":false,
\"last_updated\":\"2020-12-14T13:36:09.869Z\",
\"memorial_donations\":[
{
\"name\":\"Test MDs\",
\"website\":\"http://abc.com\",
\"memorial_donation_uuid\":\"fe7d0ed0-1537-4336-b0af-7e502b373534\",
\"last_updated\":\"2020-12-14T20:52:45.460Z\"
}
],
\"events\":[
],
\"branch_uuid\":\"a0daa794-d08d-4e9c-b460-12d3fa55921d\",
\"case_uuid\":\"4b5f0c33-d4ae-40ae-8d80-34f95a4b2224\"
}"
}
Obituary updated
:event_id=>"bbfaea2a-1ad4-4462-b2d5-7eff5ed1bb1c",
:trigger_type=>"obituary_updated",
:trigger_timestamp=>Thu, 15 Sep 2022 19:40:07 +0000,
:notification_timestamp=>Thu, 15 Sep 2022 19:40:07 +0000,
:organization_id=>"1bcd7929-7e78-432b-8f3e-e2794fe8034e",
:branch_id=>"1c79ed87-dd71-43dc-9ced-2efe89d35185",
:case_uuid=>"ce56f187-4262-4892-9382-ab2ff46b86fb",
:payload=>"{
\"content\":\"\\u003cp\\u003eRyan Francis Dallas, 48, died on May 30, 2018. He was born in College Station, TX on A On June 16, 2001, he married Christina Jane Bishop. He was a well liked man and had many of friends. He made most of his friends pranking people and making jokes that people remembered him by. He is proceeded in death by his brother Bryan Luke Dallas and his grandfather, Cameron Reid Dallas Jr. He is survived by his parents, Travis and Evelyn Dallas; his wife Christina Dallas; his daughter, Jenna Homie, and many other family and friends.\\u003c/p\\u003e\\r\\n\",
\"primary_photo\":\"https://preprod-cap.passare.com/stored_file_file/746078.jpg\",
\"secondary_photo\":\"\",
\"locked\":false,
\"last_updated\":\"2018-06-06T18:55:03.592Z\",
\"memorial_donations\":[
],
\"events\":[
],
\"branch_uuid\":\"a0daa794-d08d-4e9c-b460-12d3fa55921d\",
\"case_uuid\":\"472f7b73-2a48-48bc-bc13-c79089da0a87\"
}"