eTermin can be connected to various tools via webhooks, thus supporting custom-programmed interfaces. All you need is a URL where the webhook should be sent. The response should be "200" or "ok."
We have our own connections to Zapier and Integrately that can be used, but Zapier, for example, can also receive a webhook. Alternatively, webhooks can also be received via Make.com. You can find instructions here.
How do I set up the webhook and what settings are available?
You can set up the webhook in the API > API & Web Push menu item. To do this, enable the Send Web Push option and then enter the URL in the Send to the following URL field. Optionally, you can also specify a variable in the header or store a secret hash key.
To do this, enter the name of the variable in the Http header name field and the value in the Http value field, or rather enter the value in the Secret key hash field. You can also select whether the webhook should be passed as a variables or JSON.
You can use the Send Web Push (Created/Deleted/Modified) with test values buttons to test the implementation without booking an appointment. Please save your changes and reload the page first.
Which fields are passed?
If you receive the data as JSON, all fields will always be listed. If you pass the data as variables, only the fields that are actually filled will be displayed.
| command | CREATED, MODIFIED, DELETED, depending on what happened |
| appointmentUID | external ID of the appointment |
| startDateTimeUTC | start time of the appointment in UTC |
| endDateTimeUTC | end time of the appointment in UTC |
| startDateTime | start time of the appointment in the selected time zone |
| endDateTime | end time of the appointment in the selected time zone |
| bookingDateUTC | time of booking |
| salutation | salutation |
| lastName | last name |
| firstName | first name |
| phone | phone number |
| street | street |
| ZIP | zip code |
| town | town or city |
| birthday | birthday |
| notes | notes or comment field |
| customerNumber | customer number |
| additional1 | additional field 1 |
| additional2 | additional field 2 |
| additional3 | additional field 3 |
| additional4 | additional field 4 |
| additional5 | additional field 5 |
| additional6 | additional field 6 |
| additional7 | additional field 7 |
| additional8 | additional field 8 |
| additional9 | additional field 9 |
| additional10 | additional field 10 |
| additional11 | additional field 11 |
| additional12 | additional field 12 |
| additional13 | additional field 13 |
| additional14 | additional field 14 |
| additional15 | additional field 15 |
| additional16 | additional field 16 |
| additional17 | additional field 17 |
| additional18 | additional field 18 |
| additional19 | additional field 19 |
| additional20 | additional field 20 |
| selectedAnswers | name of the selected service |
| selAnswersAbbreviation | abbreviation of the selected service |
| bookingLanguage | country code of the language selected when booking an appointment |
| calendarName | name of the calendar |
| calendarID | ID of the calendar |
| serviceid | ID of the selected service |
| attachmentLink1 | link for uploaded files 1 |
| attachmentLink2 | link for uploaded files 2 |
| attachmentLink3 | link for uploaded files 3 |
| attachmentLink4 | link for uploaded files 4 |
| attachmentLink5 | link for uploaded files 5 |
| attachmentLink6 | link for uploaded files 6 |
| state | state |
| capacity | capacity of the appointment |
| referenceCode | reference code of the appointment |
| appAttrib | attribute of the appointment (Integer, the attributes are binary coded) |
| newsletter | 1 if the newsletter was accepted, 0 if not |
| reason | Reason e.g. why an appointment was deleted |
| location | location of the appointment |
| userid | user who created/modified the appointment |
| externalidold | Old external ID, if it changes during synchronization |
| id | eTermin internal ID of the appointment |
| contactid | ID of the contact that was used |
| voucherCode | used voucher code |
| linkedAppIDs | Ids of the linked appointments |
| priceGross | total price |
| title | title |
| company | company |
| meetingPassword | Password for the meeting, if e.g. Zoom is connected |
The sent webhooks are recorded in the API > Logs menu item and can be traced there for the last 14 days. Other integrations are also listed here. Here are two example test data sets, the first passed via variables and the second via JSON.
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.