POST Appointment

POST https://webhook.example.com
application/json

Body Required

Responses

  • Your server returns this code if it succesfully processed the event

  • Your server returns this code if it succesfully processed the event

  • Your server returns this code if it succesfully processed the event

  • Your server returns this code if it succesfully processed the event

POST Appointment
Request examples
{
  "id": "string",
  "correlationId": "string",
  "webhookConfigurationId": "string",
  "version": "string",
  "entity": "Appointment",
  "data": {
    "eventType": "ACCEPT",
    "message": "string",
    "appointment": {
      "id": "string",
      "subject": {
        "id": "string",
        "externalId": "string",
        "enabledForCustomerUse": true,
        "enabledForInternalUse": true,
        "order": 42,
        "cancellationByAgentFormId": "string",
        "cancellationByCustomerFormId": "string",
        "completionByAgentFormId": "string",
        "questionnaireFormId": "string",
        "subjectGroup": {
          "id": "string",
          "externalId": "string",
          "order": 42,
          "color": "string",
          "image": "string",
          "translations": {
            "name": [
              {
                "value": "string",
                "language": "string"
              }
            ]
          },
          "createdAt": "2024-05-04T09:42:00+00:00",
          "updatedAt": "2024-05-04T09:42:00+00:00"
        },
        "translations": {
          "name": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "description": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "instructions": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        },
        "createdAt": "2024-05-04T09:42:00+00:00",
        "updatedAt": "2024-05-04T09:42:00+00:00"
      },
      "office": {
        "id": "string",
        "active": true,
        "email": "string",
        "externalId": "string",
        "phoneNumber": "string",
        "timeZone": "string",
        "usesIndependentAgents": true,
        "virtual": true,
        "location": {
          "postalCode": "string",
          "countryCode": "string",
          "geolocation": {
            "latitude": 42.0,
            "longitude": 42.0
          },
          "translations": {
            "city": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "street1": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "street2": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "state": [
              {
                "value": "string",
                "language": "string"
              }
            ]
          }
        },
        "translations": {
          "name": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "description": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "directions": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "parkingInfo": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        },
        "createdAt": "2024-05-04T09:42:00+00:00",
        "updatedAt": "2024-05-04T09:42:00+00:00"
      },
      "participants": [
        {
          "role": "PRIMARY",
          "type": "EMPLOYEE",
          "token": "string",
          "videoUrl": "string",
          "videoTestUrl": "string",
          "cancelUrl": "string",
          "editUrl": "string",
          "inviteUrl": "string",
          "office365CalendarUrl": "string",
          "googleCalendarUrl": "string",
          "icalUrl": "string",
          "createdAt": "2024-05-04T09:42:00+00:00",
          "employee": {
            "id": "string",
            "communicationEmail": "string",
            "email": "string",
            "externalId": "string",
            "firstName": "string",
            "language": "string",
            "lastName": "string",
            "onlinePlanning": true,
            "phoneNumber": "string",
            "profilePictureUrl": "string",
            "staticVideoUrl": "string",
            "translations": {
              "function": [
                {
                  "value": "string",
                  "language": "string"
                }
              ]
            },
            "availableRoles": [
              "ADMIN"
            ],
            "status": "ACTIVE",
            "timeZone": "string",
            "userId": "string",
            "createdAt": "2024-05-04T09:42:00+00:00",
            "updatedAt": "2024-05-04T09:42:00+00:00"
          }
        }
      ],
      "answers": [
        {
          "id": "string",
          "form": {
            "id": "string"
          },
          "question": {
            "id": "string",
            "externalId": "string",
            "order": 42,
            "translations": {
              "label": [
                {
                  "value": "string",
                  "language": "string"
                }
              ]
            }
          },
          "answerType": "SUBJECT_QUESTIONNAIRE",
          "value": "string",
          "selectedAnswerOptions": [
            {
              "id": "string",
              "externalId": "string",
              "value": "string"
            }
          ],
          "files": [
            {
              "id": "string"
            }
          ],
          "createdAt": "2024-05-04T09:42:00+00:00",
          "updatedAt": "2024-05-04T09:42:00+00:00"
        }
      ],
      "location": {
        "postalCode": "string",
        "countryCode": "string",
        "geolocation": {
          "latitude": 42.0,
          "longitude": 42.0
        },
        "translations": {
          "city": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "street1": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "street2": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "state": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        }
      },
      "listing": {
        "id": "string",
        "active": true,
        "externalId": "string",
        "timeZone": "string",
        "location": {
          "postalCode": "string",
          "countryCode": "string",
          "geolocation": {
            "latitude": 42.0,
            "longitude": 42.0
          },
          "translations": {
            "city": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "street1": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "street2": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "state": [
              {
                "value": "string",
                "language": "string"
              }
            ]
          }
        },
        "tags": [
          "string"
        ],
        "translations": {
          "name": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "description": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        },
        "createdAt": "2024-05-04T09:42:00+00:00",
        "updatedAt": "2024-05-04T09:42:00+00:00"
      },
      "leadSegment": {
        "id": 42,
        "active": true,
        "code": "string",
        "description": "string",
        "createdAt": "2024-05-04T09:42:00+00:00",
        "updatedAt": "2024-05-04T09:42:00+00:00",
        "deletedAt": "string"
      },
      "meetingType": "OFFICE",
      "externalId": "string",
      "hybrid": true,
      "trailingBufferTime": 42,
      "internalNotes": "string",
      "meetingRoom": {
        "id": "string",
        "email": "string",
        "externalId": "string",
        "name": "string",
        "provider": "string",
        "createdAt": "2024-05-04T09:42:00+00:00",
        "updatedAt": "2024-05-04T09:42:00+00:00",
        "deletedAt": "string"
      },
      "messageForCustomer": "string",
      "metadata": {},
      "createdAt": "2024-05-04T09:42:00+00:00",
      "createdById": "string",
      "createdByType": "CUSTOMER",
      "createdFrom": "PLUGIN",
      "updatedAt": "2024-05-04T09:42:00+00:00",
      "updatedById": "string",
      "updatedByType": "CUSTOMER",
      "updatedFrom": "PLUGIN",
      "status": "ACCEPTED",
      "start": "2024-05-04T09:42:00+00:00",
      "end": "2024-05-04T09:42:00+00:00"
    },
    "previousAppointment": {
      "subject": {
        "id": "string"
      },
      "office": {
        "id": "string"
      },
      "participants": [
        {
          "role": "PRIMARY",
          "token": "string",
          "videoUrl": "string",
          "videoTestUrl": "string",
          "employee": {
            "id": "string"
          },
          "type": "EMPLOYEE"
        }
      ],
      "location": {
        "postalCode": "string",
        "countryCode": "string",
        "geolocation": {
          "latitude": 42.0,
          "longitude": 42.0
        },
        "translations": {
          "city": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "street1": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "street2": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "state": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        }
      },
      "listing": {
        "id": "string"
      },
      "leadSegment": {
        "id": "string"
      },
      "externalId": "string",
      "status": "ACCEPTED",
      "start": "2024-05-04T09:42:00+00:00",
      "end": "2024-05-04T09:42:00+00:00"
    }
  }
}