Change Updates

Do not miss any Pexip Engage API changes, ever again

Subscribe to the Pexip Engage API changelog to be up to date on recent changes.

RSS

Jul 1, 2025

staging
8.0.0
Compare
8.0.0

API structure has changed

26 structure changes including:
4 Breaking changes
5 Additions
19 Modifications
2 Removals
Modified 19 Breaking
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
PATCH /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /employees/{employeeId}/external-calendar-events
  • Path went from /employees/{id}/external-calendar-events to /employees/{employeeId}/external-calendar-events (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • employeeId path parameter Added
GET /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /callback-requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /callback-requests
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /employees/{id}/applied-templates/_actions/revert
  • Path went from /employees/{id}/applied-templates to /employees/{id}/applied-templates/_actions/revert (same operationId)
    Breaking
  • Verb went from DELETE to POST (same operationId)
    Breaking
POST /employees/{id}/unavailability/_actions/revert
  • Path went from /employees/{id}/unavailability to /employees/{id}/unavailability/_actions/revert (same operationId)
    Breaking
  • Verb went from DELETE to POST (same operationId)
    Breaking
Removed 2 Breaking
POST Appointmentwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Pingwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
POST CommunicationWebhookwebhook
POST CallbackRequestUpdatewebhook
POST CallbackRequestCreatewebhook
POST AppointmentUpdatewebhook
POST AppointmentCreatewebhook