Inclusion Request

Inclusion request declared by a candidate

This event is emitted every time a candidate declares a speech or communication
difficulty during a screening (an "inclusion request"). It allows your system to
be notified so the appropriate support can be arranged for the candidate.

Payload Format

The payload sent by the webhook has the following structure:

JSON

{
  "id": "notification event ID",
  "userId": "user ID",
  "candidateId": "candidate ID",
  "candidateName": "candidate's full name",
  "candidateEmail": "candidate's email",
  "screeningId": "screening ID",
  "screeningTitle": "screening title",
  "companyName": "company name",
  "channel": "WHATSAPP | WEBAPP",
  "origin": "INTERVIEW_FLOW | NOTIFICATION_FLOW",
  "declaredAt": "declaration date",
  "eventType": "INCLUSION_REQUEST",
  "ownerId": "owner ID",
  "reemitted": true | false
}

Payload Fields

• id: The unique identifier of the notification event.
  • Example: 123e4567-e89b-12d3-a456-426614174000
• userId: The unique identifier of the user (candidate) associated with the event.
  • Example: 987e4567-e89b-12d3-a456-426614174999
• candidateId: The unique identifier of the candidate who declared the inclusion request. Matches userId.
  • Example: 987e4567-e89b-12d3-a456-426614174999
• candidateName: The full name of the candidate.
  • Example: Maria Silva
• candidateEmail: The email address of the candidate.
  • Example: [email protected]
• screeningId: The unique identifier of the screening (test) related to the request.
  • Example: a23e4567-e89b-12d3-a456-426614174123
• screeningTitle: The title of the screening related to the request.
  • Example: Customer Support Analyst
• companyName: The name of the company that owns the screening.
  • Example: ACME
• channel: The channel through which the candidate declared the difficulty.
  • Possible values: WHATSAPP, WEBAPP
  • Example: WHATSAPP
• origin: The flow in which the declaration was made.
  • Possible values: INTERVIEW_FLOW, NOTIFICATION_FLOW
  • Example: INTERVIEW_FLOW
• declaredAt: The date and time when the candidate declared the inclusion request.
  • Example: 2024-10-15T12:34:56Z
• eventType: The type of event. Always INCLUSION_REQUEST for this webhook.
  • Example: INCLUSION_REQUEST
• ownerId: The unique identifier of the account (business owner) of the screening.
  • Example: 456e4567-e89b-12d3-a456-426614174222
• reemitted: A flag indicating whether this event is a re-emission of a previously sent event.
  • Example: false