Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

expand
string | null

A comma-separated list of additional fields to expand. Supported values: provider_events (the per-provider event configuration). These are returned as null unless requested.

Example:

"provider_events"

Body

application/json
webhook_url
string
required

The https URL events are delivered to. localhost and numeric IP addresses are rejected, and a hostname that does not resolve in DNS fails the request with a 502.

Example:

"https://example.com/stackone/webhooks"

events
enum<string>[]
required

The events the webhook is subscribed to. Send an empty list for a webhook that only receives connector events routed to it from a connector profile.

A unified webhook event type.

Available options:
account.created,
account.updated,
account.deleted,
hris_employees.created,
hris_employees.updated,
hris_employees.deleted,
hris_employments.created,
hris_employments.updated,
hris_employments.deleted,
hris_time_off.created,
hris_time_off.updated,
hris_time_off.deleted,
hris_tasks.created,
hris_tasks.updated,
hris_tasks.deleted,
hris_shifts.created,
hris_shifts.updated,
hris_shifts.deleted,
ats_assessments.created,
ats_background_checks.created,
ats_candidates.created,
ats_candidates.updated,
ats_candidates.deleted,
ats_applications.created,
ats_applications.updated,
ats_applications.deleted,
ats_interviews.created,
ats_interviews.updated,
ats_interviews.deleted,
ats_jobs.created,
ats_jobs.updated,
ats_jobs.deleted,
ats_job_postings.created,
ats_job_postings.updated,
ats_job_postings.deleted,
ats_users.created,
ats_users.updated,
ats_users.deleted,
ats_lists.created,
ats_lists.updated,
ats_lists.deleted,
crm_contacts.created,
crm_contacts.updated,
crm_contacts.deleted,
crm_accounts.created,
crm_accounts.updated,
crm_accounts.deleted,
lms_completions.created,
lms_completions.updated,
lms_completions.deleted,
lms_content.created,
lms_content.updated,
lms_content.deleted,
lms_assignments.created,
lms_assignments.updated,
lms_assignments.deleted,
lms_courses.created,
lms_courses.updated,
lms_courses.deleted,
lms_users.created,
lms_users.updated,
lms_users.deleted,
documents_files.created,
documents_files.updated,
documents_files.deleted,
documents_folders.created,
documents_folders.updated,
documents_folders.deleted,
documents_drives.created,
documents_drives.updated,
documents_drives.deleted,
screening_results.created,
screening_results.updated,
screening_results.deleted
Example:
label
string | null
default:webhook

A display label for the webhook.

Example:

"Production"

provider_events
object | null

The per-provider event configuration, keyed by provider key and then by unified event name. programmatic and manual provider events the connector does not support are ignored.

Response

The webhook was created.

id
string
required

The unique identifier of the webhook.

label
string
required

The display label of the webhook.

webhook_url
string
required

The URL webhook events are delivered to.

events
string[]
required

The unified event names the webhook is subscribed to (e.g. employee.created).

status
enum<string>
required

The status of the webhook.

Available options:
active,
inactive,
suspended,
archived,
expired,
error,
unmapped_value,
null
status_reasons
object[]
required

The reasons explaining the current status; empty when none are recorded.

provider_events
object | null
required

The per-provider event configuration, keyed by provider key and then by unified event name. Only resolved when expand=provider_events is requested; null otherwise.

created_at
string<date-time>
required

When the webhook was created.

updated_at
string<date-time>
required

When the webhook was last updated.

signing_secret
string | null
required

The secret used to sign webhook payloads, for signature verification; null when none is stored.