---
title: "Create Webhook Setting"
method: POST
path: "/v2/webhook_settings"
tags: ["Webhook Settings"]
---

# Create Webhook Setting

`POST /v2/webhook_settings`

Create a new webhook setting. Allowed types:

- **Webhooks::Settings::ApplicantSave** - Fires when an applicant is created or updated
- **Webhooks::Settings::ApplicantStateChange** - Fires when an applicant's application state changes
- **Webhooks::Settings::Transition** - Fires when an applicant transitions between workflow stages (supports configurable strategies: first, hired, rejected, archived, all, or selected stages)
- **Webhooks::Settings::CheckrStatus** - Fires when a Checkr background check status changes (clear, consider, suspended, engaged, pre_adverse, post_adverse, dispute)
- **Webhooks::Settings::OnfidoStatus** - Fires when an Onfido identity verification status changes (clear, consider)
- **Webhooks::Settings::FunnelSave** - Fires when an opening is created or updated
- **Webhooks::Settings::HiringGoalChange** - Fires when a hiring goal is modified
- **Webhooks::Settings::PartnerStatus** - Fires when a partner integration status changes
- **Webhooks::Settings::FileStatus** - Fires when an uploaded file's status changes
- **Webhooks::Settings::PosthireDataCollectionApproval** - Fires when post-hire documents and/or data fields are approved
- **Webhooks::Settings::PosthireWorkerActivation** - Fires when a post-hire worker is activated
- **Webhooks::Settings::PosthireWorkerDeactivation** - Fires when a post-hire worker is deactivated
- **Webhooks::Settings::PosthireDocumentUploaded** - Fires when a document is uploaded for a post-hire worker
- **Webhooks::Settings::LocationSave** - Fires when a location is created or updated

## Request body

- object
  - `type` string, required — The webhook type (see description for allowed values)
  - `title` string, required — Title for the webhook setting
  - `url` string, required — The HTTPS URL that will receive webhook payloads
  - `authorization_method` 'no_auth' | 'simple' | 'oauth' — Authorization method
  - `authorization_header` string — Authorization header value (required if authorization_method is simple)
  - `disabled` boolean — Whether the webhook should be disabled
  - `send_secure_data` boolean — Whether to include secure data in webhook payloads

## Response `201`

Created

- object
  - `webhook_setting` WebhookSetting
    - `id` string, required — Unique identifier for the webhook setting
    - `type` string, required — The webhook type
    - `title` string, required — Title of the webhook setting
    - `url` string, required — The URL that will receive webhook payloads
    - `disabled` boolean, required — Whether the webhook is disabled
    - `authorization_method` 'no_auth' | 'simple' | 'oauth', required — Authorization method for the webhook
    - `authorization_header` string, nullable — The authorization header value
    - `send_secure_data` boolean — Whether to include secure data in webhook payloads
    - `created_at` string, date-time, required — When the webhook setting was created
    - `updated_at` string, date-time, required — When the webhook setting was last updated

## Other responses

- `401` — Unauthorized
- `422` — Unprocessable Entity - Invalid webhook type

---

[API](https://skmtc.net/fountain/apis/hire-public-api.md) · [All operations](https://skmtc.net/fountain/apis/hire-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fountain/hire-public-api/revisions/5f406c0e9462/schema)