Overview

You can subscribe to this API to receive information about events that happen to a candidate assessment record in PSI system. This service helps in keeping the status of record(s) in sync across all integrated systems. For example when the candidate schedules for an exam, this service can keep all related systems informed about the change in status of the candidate record.

When an event occurs, PSI creates an event object to keep track of the type of event, the time when it occurred, and the data associated with the event. PSI can post the event information to your server via an HTTPS PUT request. A full list of event types can been found in the payload section below.

When sending notification, PSI will wait for a success response for a short time, after which the delivery will be considered a failure, and the event will be moved into error queued. Events in the error queue can be reconsidered for delivery at later point of time. Resending of notifications from the error queue is manual at present. Every event maintains the UTC timestamp at which it was generated in PSI system. It is important that the receiving system treats the sequence of events based on this timestamp field irrespective of the sequence in which these are received.

Subscription

There are two requirements to enable event notifications:

1. You must create an endpoint page on your server that can receive an HTTPS PUT request from PSI. This page must be accessible by PSI event notification service and it should be configured to receive JSON data via HTTPS PUT. Your endpoint must use a valid signed SSL certificate.
2. You must be a trusted API partner with PSI to receive the notifications. Trusted partners must establish a protocol of trust covering authentication and system to system communication in non-production environment first.

Receiving Events

After you specify your notification_url and established a authentication mechanism, PSI will automatically begin notifying your system for the events as they occur. Your server must return an HTTP status code of 200 to indicate that the notification was received. If PSI receives any other status code or no response, the notification will be considered a failure and moved to an error_queue for a manual retry later. The retry logic will be automated in the near future.

Authentication

PSI can integrate with external systems using any authentication scheme. PSI recommends using OAauth2 guidelines to follow industry standard security.

Request

PUT https:///notifications

Request body

The request body takes a complete NotificationRequest resource, containing the following writable properties:

{
    "booking_code": "string",
    "booking_on": "string",
    "candidate_fname": "string",
    "candidate_id": "string",
    "candidate_lname": "string",
    "candidate_mname": "string",
    "change_reason": "string",
    "client_eligibility_id": "string",
    "delivery_mode": "string",
    "effective_date": "string",
    "exam_code": "string",
    "exam_portions": [
        {
            "portion_code": "string",
            "portion_name": "string"
        }
    ],
    "location_address": "string",
    "location_code": "string",
    "location_name": "string",
    "location_timezone": "string"
}

Properties

Response

The following HTTP status codes may be returned, optionally with a response resource.

Try it out!