v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Webhooks

ApiPublic > WebhookSubscription > Creates

Subscription_type: api_public/webhook_subscription/create

postWebhookWebhooks > ApiPublic > WebhookSubscription > Creates

Payload

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 payload

{
  "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"
}

Response

Return a 200 status to indicate that the data was received successfully