New Appointment Example
This webhook is used when a new appointment for a customer is created. The request body contains detailed information about the appointment, including start and end times, appointment type, customer information, and the creator's details.
| Value Name | Description | Value Type |
|---|---|---|
name | Name of the appointment. | string |
enerflo_apt_id | Enerflo appointment ID | integer |
id | Appointment ID. | integer |
survey_id | Survey ID associated with the appointment. | integer |
tz | Time zone of the appointment. | string |
enerflo_customer_id | Enerflo customer ID. | integer |
external_customer_id | External customer ID. | integer |
start_time | Appointment start time in ISO 8601 format. | string |
end_time | Appointment end time in ISO 8601 format. | string |
appointment_date | Date of the appointment. | string |
appointment_start_time | Start time of the appointment in 12-hour format. | string |
appointment_end_time | End time of the appointment in 12-hour format. | string |
start_time_iso8601 | Start time in ISO 8601 format. | string |
end_time_iso8601 | End time in ISO 8601 format. | string |
start_time_local | Local start time. | string |
end_time_local | Local end time. | string |
start_time_only_local | Local start time in 12-hour format. | string |
end_time_only_local | Local end time in 12-hour format. | string |
start_time_local_rfc | Local start time in RFC format. | string |
end_time_local_rfc | Local end time in RFC format. | string |
unix_time | Unix timestamp for start time. | integer |
unix_time_end | Unix timestamp for end time. | integer |
start_time_zulu | Start time in Zulu format. | string |
end_time_zulu | End time in Zulu format. | string |
start_time_rfc822 | Start time in RFC 822 format. | string |
end_time_rfc822 | End time in RFC 822 format. | string |
start_time_rfc850 | End time in RFC 822 format. | string |
end_time_rfc850 | End time in RFC 850 format. | string |
len | Duration of the appointment in minutes. | integer |
status | Appointment status. | string |
external_notes | External notes related to the appointment. | string |
internal_notes | Internal notes related to the appointment. | string |
timezone | Time zone of the appointment. | string |
appointment_type | Type of appointment. | string |
appointment_type_id | Appointment type ID. | integer |
appointment_status | Status of the appointment. | string |
assignedOffice | Assigned office for the appointment. | string |
created_at | Appointment creation timestamp. | string |
updated_at | Last update timestamp for the appointment. | string |
creator | Information about the creator of the appointment | object |
assigned_user | Information about the assigned user. | object |
epc_company | An object containing detailed information about a specific market associated with the company. | object |
customer | An object containing comprehensive information about a customer, including personal details, contact information, and various associated metadata. Here is a detailed description of each key-value pair within the object. | object |
eventName | The name of the event that triggered the current action or record. It typically indicates the type of operation or status change in the system. | string |
Example Payload
"body": {
"name": "Enerflo Solar Consultation with Test Deal",
"enerflo_apt_id": 00000000,
"id": 00000000,
"survey_id": null,
"tz": "America/Los_Angeles",
"enerflo_customer_id": 0000000,
"external_customer_id": null,
"start_time": "2024-10-11T13:00:00+00:00",
"end_time": "2024-10-11T13:30:00+00:00",
"appointment_date": "2024-10-11",
"appointment_start_time": "1:00 pm",
"appointment_end_time": "1:30 pm",
"start_time_iso8601": "2024-10-11T13:00:00+00:00",
"end_time_iso8601": "2024-10-11T13:30:00+00:00",
"start_time_local": "2024-10-11T06:00:00-07:00",
"end_time_local": "2024-10-11T06:30:00-07:00",
"start_time_only_local": "6:00 am",
"end_time_only_local": "6:30 am",
"start_time_local_rfc": "Friday, 11-Oct-24 06:00:00 PDT",
"end_time_local_rfc": "Friday, 11-Oct-24 06:30:00 PDT",
"unix_time": 1728651600,
"unix_time_end": 1728653400,
"start_time_zulu": "2024-10-11T13:00:00Z",
"end_time_zulu": "2024-10-11T13:30:00Z",
"start_time_rfc822": "Fri, 11 Oct 24 13:00:00 +0000",
"end_time_rfc822": "Fri, 11 Oct 24 13:30:00 +0000",
"start_time_rfc850": "Friday, 11-Oct-24 13:00:00 UTC",
"end_time_rfc850": "Friday, 11-Oct-24 13:30:00 UTC",
"len": 30,
"status": "confirmed",
"external_notes": "",
"internal_notes": null,
"timezone": "America/Los_Angeles",
"appointment_type": "In-Home",
"appointment_type_id": 0000,
"appointment_status": null,
"assignedOffice": null,
"created_at": "2024-10-10 18:58:48",
"updated_at": "2024-10-10 18:59:10",
"creator": {
"first_name": "Enerflo",
"last_name": "Admin1",
"email": "[email protected]",
"valid_email": 1,
"phone": "1111111111",
"timezone": "America/Denver",
"is_active": 1,
"id": 00000,
"meta": {
"intercom_id": "0123abc456",
"allow_optimus": "1",
"valid_email_ts": "2024-10-02 23:49:45",
"has_valid_email": 1
}
},
"assigned_user": {
"first_name": "Enerflo",
"last_name": "Admin",
"email": "[email protected]",
"valid_email": 1,
"phone": "1234567890",
"timezone": "America/New_York",
"is_active": 1,
"id": 66211,
"meta": {
"inactive": "0",
"intercom_id": "123abc456def",
"is_view_only": "0",
"allow_optimus": "1",
"valid_email_ts": "2024-10-02 23:49:39",
"has_valid_email": 1,
"can_create_customers": "1",
"primary_sms_supported": 0,
"can_create_manual_installs": "0",
"create_update_change_order": "0"
}
},
"epc_company": {
"id": 0000,
"epc_company_id": 0000,
"company_id": 0000,
"meta_data": {
"crmId": null,
"ppwChanges": "1",
"requestDelay": null,
"epc_financing": "1",
"enerfloDesigns": "2",
"revisionFields": null,
"accessProposals": null,
"designProposals": "1",
"state_overrides": null,
"survey_type_ids": [
"0000"
],
"ccEnerfloRequest": null,
"chatNotifications": null,
"showSolarDesignUser": "0",
"disable_adder_pricing": null,
"disableEpcUserCloaking": null,
"proposalRequestSectionIds": [
"0000"
],
"sales_org_project_settings": null,
"disable_milestone_notification": null,
"allow_sales_to_approve_contracts": null
},
"created_at": "2023-06-16 13:43:27",
"updated_at": "2023-06-16 20:22:25",
"disabled": 0
},
"customer": {
"company_id": 0000,
"office_id": null,
"creator_id": 0000,
"agent_id": 0000,
"setter_id": null,
"first_name": "Enerflo",
"last_name": "Test",
"email": "[email protected]",
"mobile": "1234567890",
"secondary_first_name": "",
"secondary_last_name": "",
"secondary_mobile": "",
"secondary_email": "",
"address": "20422 Beach Blvd #215",
"city": "Huntington Beach",
"state": "CA",
"zip": "92648",
"county": "Orange County",
"lat": "33.66588930",
"lng": "-117.98808800",
"timezone": "America/Los_Angeles",
"details": null,
"external_id": null,
"lead_source": "Social Media",
"meta_data": {
"class": "App\\Http\\Controllers\\CustomerController",
"method": "in_app",
"function": "addCustomer",
"has_valid_email": 1,
"primary_sms_supported": 0
},
"status_id": -1,
"lead_router_id": null,
"referral_id": null,
"deleted_at": null,
"language": "en_US",
"unit_number": "",
"initial_contact": 0,
"deleted_by": null,
"fullName": "Enerflo Test",
"id": 0123456,
"created": "2024-10-10T18:57:53+00:00",
"updated": "2024-10-10T18:57:53+00:00",
"fullState": "California",
"fullAddress": "20422 Beach Blvd #215 Huntington Beach, CA 92648",
"status_name": null,
"created_by_name": "Enerflo Admin1",
"created_by_email": "[email protected]",
"created_by_phone": "(987) 654-3251",
"creator": {
"first_name": "Enerflo",
"last_name": "Admin1",
"email": "[email protected]",
"phone": "1111111111",
"timezone": "America/Denver",
"id": 66219
},
"integrations": {
"Enerflo V2": {
"EnerfloV2Customer": {
"integration_record_id": "123abc-654a-789c-123a-321456987",
"record_type": "EnerfloV2Customer",
"enerflo_id": 0000000,
"last_synced": "2024-10-10T18:57:53+00:00",
"updated_at": "2024-10-10T18:57:53+00:00",
"created_at": "2024-10-10T18:57:53+00:00"
}
}
},
"owner": {
"first_name": "Enerflo",
"last_name": "Admin1",
"email": "[email protected]",
"valid_email": 1,
"phone": "1111111111",
"timezone": "America/Denver",
"is_active": 1,
"id": 00000,
"meta": {
"intercom_id": "123abc456def",
"allow_optimus": "1",
"valid_email_ts": "2024-10-02 23:49:45",
"has_valid_email": 1
}
},
"company": {
"company_name": "Enerflo Solar",
"company_phone": "1111111111",
"company_address": "123 main street",
"company_city": "New York",
"company_state": "NY",
"company_zip": "84622",
"company_email": "[email protected]",
"company_timezone": "America/Denver"
},
"customer_notes": "",
"futureAppointments": [],
"surveys": [],
"loan_application_details": {
"lender": "N/A",
"application_status": "N/A",
"application_date": "N/A"
}
},
"eventName": "new_appointment"
}
Updated about 1 month ago