Insyko Documentation

Appearance

Webhooks ​

Our system can notify your application about applicant-related changes using webhooks.
To start receiving notifications, provide a Webhook URL in your project configuration.

We will send an HTTPS POST request to your URL with a JSON payload.

Setup ​

  • Webhook URL: the HTTPS endpoint on your system that will receive webhook calls.
  • Signature Key: used to sign webhook requests for authenticity verification. so you can verify authenticity of incoming request in your system.
  • Method: POST
  • Content-Type: application/json

Webhook Events ​

Below are all the webhook events your system can receive.

📌 applicant.created ​

Triggered when a new applicant is created.

Example Payload ​

json
{
  "event": "applicant.created",
  "data": {
    "id": 123,
    "global_status": "wating_for_check"
  }
}

📌 applicant.updated ​

Triggered when a new applicant is updated. For example, when their verification status has changed.

Example Payload ​

json
{
  "event": "applicant.updated",
  "data": {
    "id": 123,
    "global_status": "approved" // new status f.e.
  }
}

Global Status Values ​

The global_status field can have the following values:

  • waiting_for_check: The applicant need to be verified manually from the admin panel.
  • pending: The applicant is in progress of being verified.
  • approved: The applicant has been successfully verified.
  • rejected: The applicant's verification has been rejected.

Webhook Request Format ​

When we send a webhook to your URL, the payload is plain JSON.
Only the signature header is hashed, so you can verify authenticity.

Example Request ​

http
POST /webhooks/applicants
Content-Type: application/json
Signature: sha256=4f6a1d0e3b5c9...

{
  "event": "applicant.updated",
  "data": {
    "id": 123,
    "global_status": "approved"
  }
}