Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Webhook

webhook.create

Creates a webhook setting.

Requires the apiKeysWrite permission.

post/webhook.create

Request body

webhookType'applicationSubmit' | 'applicationUpdate' | 'candidateHire' | 'candidateStageChange' | 'candidateDelete' | 'candidateMerge' | 'interviewPlanTransition' | 'interviewScheduleCreate' | 'interviewScheduleUpdate' | 'jobCreate' | 'jobUpdate' | 'jobPostingUpdate' | 'jobPostingDelete' | 'jobPostingPublish' | 'jobPostingUnpublish' | 'openingCreate' | 'offerCreate' | 'offerUpdate' | 'offerDelete' | 'pushToHRIS' | 'surveySubmit' | 'takeHomeAssignmentAssigned' | 'takeHomeAssignmentCancelled' | 'takeHomeAssignmentCompleted' | 'takeHomeAssignmentSubmitted' | 'signatureRequestUpdate' required

The type of webhook

requestUrlstring uri required

The URL the webhook will send requests to

secretTokenstring required

The secret token used to sign the webhook request. See our documentation here for more information.

Example request

{
  "webhookType": "applicationSubmit"
}

Response

Responses from the webhook.create endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "enabled": true,
    "requestUrl": "https://example.com/webhook1",
    "webhookType": "applicationSubmit",
    "secretToken": "your-secret-token-here"
  }
}