Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

API key authentication for the public API. Pass your API key as a Bearer token.

Body

application/json

Request serializer for POST /webhooks.

url
string<uri>
required

Endpoint URL to send webhook events to. Must be an https URL with a publicly routable host: this endpoint rejects http, loopback, private, and link-local targets.

Required string length: 1 - 2048
event_types
enum<string>[]

Event types to subscribe to. Omit or pass [] to receive all events.

  • job_application.deleted - Job Application Deleted
  • interview.completed - Interview Completed
  • interview_v2.completed - Interview V2 Completed
  • application.created - Application Created
  • application.status_changed - Application Status Changed
  • cv_evaluation.completed - CV Evaluation Completed
  • insights.completed - Insights Completed
Available options:
job_application.deleted,
interview.completed,
interview_v2.completed,
application.created,
application.status_changed,
cv_evaluation.completed,
insights.completed

Response

Create/rotate response. The real secret is shown exactly once.

id
string<uuid>
required
read-only
url
string<uri>
required
read-only

Endpoint URL to send webhook events to. A delivery whose host resolves to a private, loopback, or link-local address is blocked and not retried, regardless of which surface created the webhook.

event_types
enum<string>[]
required
read-only

Event types this webhook subscribes to. An empty list means all events.

  • job_application.deleted - Job Application Deleted
  • interview.completed - Interview Completed
  • interview_v2.completed - Interview V2 Completed
  • application.created - Application Created
  • application.status_changed - Application Status Changed
  • cv_evaluation.completed - CV Evaluation Completed
  • insights.completed - Insights Completed
Available options:
job_application.deleted,
interview.completed,
interview_v2.completed,
application.created,
application.status_changed,
cv_evaluation.completed,
insights.completed
enabled
boolean
required
read-only

Disabled webhooks receive no deliveries.

secret
string
required
read-only
created_at
string<date-time>
required
read-only