Skip to main content
POST
/
webhook
Create a webhook
curl --request POST \
  --url https://public.api.micro1.ai/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://micro1.ai/webhook",
  "description": "Webhook for interview reports"
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
x-api-key
string
header
required

API key to access the API

Body

application/json

Request body to create a webhook

​
url
string
required

Destination URL for the webhook

Example:

"https://micro1.ai/webhook"

​
event
enum<string>
required

Event to be sent to the webhook

Available options:
interview_report.created,
interview_recording.completed,
interview_webcam_recording.completed,
proctoring_score.completed,
applicant.completed,
applicant.created,
applicant.updated,
applicant.invited,
interview.started,
interview.completed
​
description
string

Description of the webhook

Example:

"Webhook for interview reports"

Response

Successful response

​
id
string

ID of the webhook

Example:

"123e4567-e89b-12d3-a456-426614174000"