API Reference

New Approval

This event is emitted every time a candidate is approved in an interview.

Payload Format

The payload sent by the webhook has the following structure:

{
  "id": "approval event ID",
  "candidateRatingId": "candidate rating ID",
  "userId": "user ID",
  "userEmail": "user's email",
  "screeningId": "screening ID",
  "approvedAt": "approval date",
  "hasApproved": true | false,
  "webhookId": "webhook ID",
  "eventType": "APPROVAL",
  "ownerId": "owner ID",
  "reemitted": true | false,
  "partnerUserId": "partner user ID",
  "partnerJobId": "partner job ID"
}

Payload Fields

  • id: The unique identifier of the approval event.

    • Example: 123e4567-e89b-12d3-a456-426614174000

  • candidateRatingId: The identifier of the candidate rating associated with this approval.

    • Example: 456e4567-e89b-12d3-a456-426614174222

  • userId: The unique identifier of the user (candidate).

    • Example: 987e4567-e89b-12d3-a456-426614174999

  • userEmail: The email address of the candidate.

  • screeningId: The unique identifier of the screening related to the approval.

    • Example: a23e4567-e89b-12d3-a456-426614174123

  • approvedAt: The date and time when the candidate was approved.

    • Example: 2024-10-15T12:34:56Z

  • hasApproved: A flag indicating whether the candidate has been approved.

    • Example: true

  • webhookId: The unique identifier of the webhook processing this notification.

    • Example: c34e4567-e89b-12d3-a456-426614174567

  • eventType: The type of event that triggered the webhook. For this case, always APPROVAL.

    • Example: APPROVAL

  • ownerId: The unique identifier of the entity (organization or user) that owns this approval.

    • Example: d45e4567-e89b-12d3-a456-426614174321

  • reemitted: A flag indicating if the event was reemitted.

    • Example: false

  • partnerUserId: The unique identifier of the candidate in the partner’s system.

    • Example: p67e4567-e89b-12d3-a456-426614174654

  • partnerJobId: The unique identifier of the job in the partner’s system.

    • Example: j89e4567-e89b-12d3-a456-426614174987