Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
ApiPublic > WebhookSubscription

Creates a Webhook subscription

Creates a Webhook subscription

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

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-07-01' | '2025-10-01' | '2026-01-01' | '2026-04-01' | '2026-07-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"
}