Back
v1.99.1: Candidate Conversations & Messages (2026-06-25)

What's New


GET /candidates/{candidateId}/messages

Get all messages of a candidate.

POST /candidates/{candidateId}/messages

Send a message to a candidate.

POST /candidates/{candidateId}/messages/{messageId}/read

Mark a candidate message as read by admin.

DELETE /candidates/{candidateId}/messages/{messageId}

Delete an own unread admin message of a candidate.

What's Changed


POST /integrations/send-init-request
Request:

Changed content type : application/json

  • Changed property triggerEvent (string)

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent
GET /integrations/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property triggerEvent (string)

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
PATCH /integrations/{id}
Request:

Changed content type : application/json

  • Changed property triggerEvent (string)

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property triggerEvent (string)

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
POST /integrations
Request:

Changed content type : application/json

  • Changed property triggerEvent (string)

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property triggerEvent (string)

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
GET /integrations
Parameters:

Changed: filter[triggerEvent] in query

Filter by candidate 'triggerEvent' field

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object):

    • Changed property triggerEvent (string)

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
GET /integrations/logs
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Scenario for handling candidate event.

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
POST /scenarios
Request:

Changed content type : application/json

  • Changed property eventName (string)

    Scenario event type

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
GET /scenarios
Parameters:

Changed: filter[events][] in query

Search by scenario events (or)

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Scenario included relations

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
PATCH /scenarios/{id}
Request:

Changed content type : application/json

  • Changed property eventName (string)

    Scenario event type

    Added enum values:

    • candidateRejected
    • candidatePassVerificationVerified
    • candidatePassVerificationFailed
    • candidateMessageSent
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent
GET /scenarios/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property eventName (string)

      Scenario event type

      Added enum values:

      • candidateRejected
      • candidatePassVerificationVerified
      • candidatePassVerificationFailed
      • candidateMessageSent