Webhooks

Getting started

Allpass.ai uses webhooks to notify your backend when an event happens in your client-side SDK. Webhooks are useful for asynchronous events like when an applicant completes a Verification or passes any step. You should specify your backend endpoint URL and get your AES-256-CBC key.

You can do it within the workplace Application page

Every application has it's own AES-256-CBC key. Webhook data is encrypted with this key

The Allpass webhook request has the same structure as all Allpass responses:

export class ResponseEntity {
  @ApiProperty()
  status: boolean;
  
  @ApiProperty({ example: 200 })
  statusCode: number;
  
  @ApiProperty({ type: String })
  data: string;
  
  @ApiProperty({ example: '2021-08-20T14:52:33.648Z' })
  time: string;

  constructor(data: string) {
    this.status = true;
    this.statusCode = 200;
    this.data = data;
    this.time = new Date().toISOString();
  }
}

Where data is encrypted string. Read about encryption