Webhook
Create a webhook
This endpoint sets up a webhook for the AI Interviewer. It allows you to receive notifications, such as interview results, when a candidate completes the interview and the report is generated.
POST
/
webhook
Authorizations
x-api-key
string
headerrequiredAPI key to access the API
Body
application/json
url
string
requiredDestination URL for the webhook
description
string
Description of the webhook
event
enum<string>
requiredEvent to be sent to the webhook
Available options:
interview_report.created
Response
200 - application/json
id
string
ID of the webhook