Notification Webhooks

Below is a sample JRNI webhook notification payload. This payload can be customised to add or remove JRNI data / drops and tailored to your information requirements. See JRNI Customisation Guide.

JRNI Notification webhooks trigger when a booking event occurs. Types of booking events are bookings created, confirmed, modified, cancelled, session reminders or additional attendees added.

Configuration of the webhook can be completed in the JRNI Studio UI at Grandparent or Parent company level via the Settings and integrations menus.

The field definitions are the same as data webhooks, see Data Webhook Field Definitions.

{
   "appointment":{
      "bookingId":1308,
      "longId":"5D3m2ioh9Ar8XMQKMTI1MQ",
      "extCalendarId":"",
      "customerStartTime":"2023-05-31T12:00:00-04:00",
      "customerEndTime":"2023-05-31T13:00:00-04:00",
      "companyStartTime":"2023-05-31T12:00:00-04:00",
      "companyEndTime":"2023-05-31T13:00:00-04:00",
      "duration":60,
      "bookedBy":"Test Studio",
      "channel":"Administrator",
      "status":"Booking",
      "customerModifyURL":"https://example.jrni.com/book?purchase=5D3m2ioh9Ar8XMQKMTI1MQ#/amend/view",
      "adminModifyURL":"https://example.jrni.com/saml_init?id=ZKBB9ZmAdVHIOAG3z5KIlg&admin=true&view_path=bookings/edit/1308/booking/info",
      "customBookingFields":[
         {
            "ref":"Are you an existing member?",
            "value":"Yes"
         },
         {
            "ref":"Do you agree?",
            "value":"1"
         }
      ]
   },
   "company":{
      "name":"Physical Location 1",
      "description":"Location",
      "address":"1 Test Street, Suite 1, Boston, MA, 02111, United States",
      "phoneNumber":"+1 555-555-5555",
      "timezone":"America/New_York",
      "live":true,
      "disabled":false,
      "jrniId":37006,
      "externalId":"94",
      "customCompanyFields":[
         {
            "ref":"company_field",
            "value":"1"
         },
         {
            "ref":"company_field_2",
            "value":"2"
         },
         {
            "ref":"company_field_3",
            "value":"True"
         }
      ]
   },
   "service":{
      "name":"In-Person Service",
      "description":"Let us help you in person!",
      "category":"In Person Sub Category 1",
      "categoryDescription":"",
      "categoryId":21,
      "method":"In-person",
      "methodId":0,
      "disabled":false,
      "jrniId":48842,
      "externalId":"2",
      "customServiceFields":[
         {
            "ref":"service_field",
            "value":"1"
         },
         {
            "ref":"service_field_2",
            "value":"2"
         }
      ]
   },
   "staff":{
      "name":"Staff Name",
      "description":"Staff Description",
      "email":"[email protected]",
      "group":"Group",
      "groupId":1,
      "disabled":false,
      "neverBooked":true,
      "jrniId":15395,
      "externalId":"123",
      "phoneNumber":"",
      "customStaffFields":[
         {
            "ref":"person_field",
            "value":"1"
         },
         {
            "ref":"person_field_2",
            "value":"2"
         }
      ]
   },
   "resource":{
      "name":"Resource Name",
      "description":"Resource Description",
      "address":"1 Test Street, Suite 1, Boston, MA, 02111, United States",
      "email":"[email protected]",
      "disabled":false,
      "neverBooked":false,
      "jrniId":9,
      "externalId":"12345"
   },
   "customer":{
      "firstName":"Jrni",
      "lastName":"Test",
      "email":"[email protected]",
      "mobileNumber":"+1 5555551234",
      "homeNumber":"",
      "jrniId":12,
      "externalId":"",
      "locale":"en",
      "mobilePrefixCountry":"",
      "phonePrefixCountry":"",
      "mobilePrefixCountryCode":"",
      "phonePrefixCountryCode":""
   },
   "triggerName":"",
   "triggerTime":"2023-05-31T14:13:30+0000"
}