FAfactorialhr
ApiPublic > WebhookSubscription

Creates a Webhook subscription

Changed on

Creates a Webhook subscription

post/api/2026-10-01/resources/api_public/webhook_subscriptions

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/api_public/webhook_subscriptions
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token
    • or API key in header x-api-key

Request body

subscription_typestring required

Type of the webhook subscription

target_urlstring required

URL where the webhook payload will be sent

namestring

Name of the webhook subscription

challengestring

String to verify the subscription

company_idstring required

Company identifier of the webhook subscription

enabledboolean

Boolean to enable/disable the subscription

api_version'2025-10-01' | '2026-01-01' | '2026-04-01' | '2026-07-01' | '2026-10-01'

API version of the webhook subscription that determines the schema of the payload

Example request

{
  "subscription_type": "ats/job_posting/create",
  "target_url": "https://webhook.site/",
  "name": "Webhook subscription of a job posting created",
  "challenge": "2bca4e6d-9aaf-4f11-9e5d",
  "company_id": "1",
  "enabled": true
}

Response

CREATED

idstring required

Identifier of the webhook subscription

target_urlstring required

URL where the webhook payload will be sent

typestring required

Type of the webhook subscription

company_idstring required

Company identifier of the webhook subscription

namestring

Name of the webhook subscription

challengestring

String to verify the subscription

enabledboolean required

Boolean to enable/disable the subscription

api_versionstring required

API version of the webhook subscription that determines the schema of the payload

Example response

{
  "id": "1",
  "target_url": "https://webhook.site/",
  "type": "ats/job_posting/create",
  "company_id": "1",
  "name": "Webhook subscription of a job posting created",
  "challenge": "2bca4e6d-9aaf-4f11-9e5d",
  "enabled": true,
  "api_version": "2026-07-01"
}

Changes