---
title: "webhook.create"
method: POST
path: "/webhook.create"
tags: ["Webhook"]
---

# webhook.create

`POST /webhook.create`

Creates a webhook setting.

**Requires the [`apiKeysWrite`](authentication#permissions-webhookcreate) permission.**

## Request body

- WebhookCreateRequest
  - `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
  - `requestUrl` string, uri, required — The URL the webhook will send requests to
  - `secretToken` string, required — The secret token used to sign the webhook request. See our documentation [here](https://developers.ashbyhq.com/docs/authenticating-webhooks) for more information.

## Response `200`

Responses from the webhook.create endpoint

- union
  - WebhookCreateSuccessResponse
    - `success` true, required
    - `results` WebhookSetting, required
      - `id` string, uuid, required — The unique identifier for the webhook
      - `enabled` boolean, required — Whether or not the webhook setting is enabled
      - `requestUrl` string, uri, required — The URL the webhook will send requests to
      - `secretToken` string, nullable, required — The secret token used to sign the webhook request. See our documentation [here](https://developers.ashbyhq.com/docs/authenticating-webhooks) for more information.
      - `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
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)