Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"application_id",
"rule"
],
"properties": {
"rule": {
"type": "object",
"required": [
"trigger",
"action"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200
},
"action": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"task"
],
"properties": {
"task": {
"type": "object",
"required": [
"assignee",
"title"
],
"properties": {
"title": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"due_in": {
"type": "object",
"required": [
"value",
"unit"
],
"properties": {
"unit": {
"enum": [
"days",
"hours"
],
"type": "string"
},
"value": {
"type": "integer",
"maximum": 8760,
"minimum": 1
}
},
"additionalProperties": false
},
"assignee": {
"anyOf": [
{
"type": "string",
"const": "recruiter"
},
{
"type": "object",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"const": "update_scheduling"
},
"delivery": {
"enum": [
"auto_send",
"auto_draft_review"
],
"type": "string",
"default": "auto_draft_review"
},
"template_key": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"task_type",
"task_title"
],
"properties": {
"type": {
"type": "string",
"const": "create_task"
},
"due_in": {
"type": "object",
"required": [
"value",
"unit"
],
"properties": {
"unit": {
"enum": [
"days",
"hours"
],
"type": "string"
},
"value": {
"type": "integer",
"maximum": 8760,
"minimum": 1
}
},
"description": "Due this many days or hours after the rule fires; at most 365 days or 8760 hours. Cannot combine with due_date.",
"additionalProperties": false
},
"context": {
"type": "object",
"additionalProperties": {}
},
"due_date": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Existing fixed deadline; use due_in for recurring rules."
},
"task_type": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Add to My Tasks: scorecard_review on feedback_submitted, or coordination for a general follow-up. Same-kind tasks are stacked."
},
"task_title": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Task title; {candidate} resolves to the candidate name."
},
"assigned_role": {
"enum": [
"assigned_interviewer",
"recruiter",
"hiring_manager",
"team_owner"
],
"type": "string"
},
"assigned_user_email": {
"type": "string",
"maxLength": 320,
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "send_email"
},
"email_type": {
"anyOf": [
{
"enum": [
"acknowledgment",
"advancement",
"interview_confirmation",
"rejection",
"offer_declined",
"offer",
"hired",
"withdrawn",
"on_hold"
],
"type": "string"
},
{
"type": "string",
"const": "interview_cancellation"
}
]
},
"sender_type": {
"enum": [
"owner",
"job_hiring_manager"
],
"type": "string",
"description": "Who the email comes from: owner (the job recruiter) or job_hiring_manager. Omit to use the company's sender setting."
},
"template_key": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"interview_ids",
"format"
],
"properties": {
"type": {
"type": "string",
"const": "send_scheduling_invitation"
},
"format": {
"enum": [
"combined",
"separate"
],
"type": "string"
},
"template_key": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"interview_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "send_preparation_email"
},
"template_key": {
"enum": [
"candidate_preparation",
"onsite_logistics",
"technical_preparation"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"audience",
"template"
],
"properties": {
"type": {
"type": "string",
"const": "send_internal_email"
},
"audience": {
"enum": [
"assigned_interviewer",
"recruiter",
"hiring_manager",
"team_owner",
"offer_approver",
"offer_requester"
],
"type": "string"
},
"template": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "verify_calendar_event"
}
},
"additionalProperties": false
}
]
},
"job_id": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"timing": {
"anyOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "immediate"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"delayMinutes"
],
"properties": {
"type": {
"type": "string",
"const": "delay"
},
"delayMinutes": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"anchor",
"offsetMinutes"
],
"properties": {
"type": {
"type": "string",
"const": "interview_relative"
},
"anchor": {
"enum": [
"start",
"end"
],
"type": "string"
},
"offsetMinutes": {
"type": "integer"
}
},
"additionalProperties": false
}
]
},
"trigger": {
"enum": [
"stage_enter",
"stage_exit",
"step_ready",
"booking_created",
"booking_changed",
"step_completed",
"feedback_submitted",
"all_scorecards_submitted",
"hiring_manager_advanced",
"hiring_manager_held",
"interview_time",
"assignment_changed",
"booking_cancelled",
"scorecard_due",
"scorecard_overdue",
"decision_brief_ready",
"coaching_report_ready",
"offer_approval_due",
"offer_approval_escalation_due"
],
"type": "string"
},
"position": {
"type": "integer",
"minimum": 0
},
"condition": {
"type": "object",
"properties": {
"step_kinds": {
"type": "array",
"items": {
"enum": [
"candidate_interview",
"reference_check",
"internal_debrief",
"offer_meeting"
],
"type": "string"
},
"minItems": 1
},
"interview_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"step_position": {
"anyOf": [
{
"type": "object",
"required": [
"which"
],
"properties": {
"which": {
"type": "string",
"const": "next"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"which",
"kind"
],
"properties": {
"kind": {
"enum": [
"candidate_interview",
"reference_check",
"internal_debrief",
"offer_meeting"
],
"type": "string"
},
"which": {
"type": "string",
"const": "first"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"which",
"kind"
],
"properties": {
"kind": {
"enum": [
"candidate_interview",
"reference_check",
"internal_debrief",
"offer_meeting"
],
"type": "string"
},
"which": {
"type": "string",
"const": "last"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"which",
"kind",
"anchor_kind"
],
"properties": {
"kind": {
"enum": [
"candidate_interview",
"reference_check",
"internal_debrief",
"offer_meeting"
],
"type": "string"
},
"which": {
"type": "string",
"const": "last_before"
},
"anchor_kind": {
"enum": [
"candidate_interview",
"reference_check",
"internal_debrief",
"offer_meeting"
],
"type": "string"
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": true
},
"is_active": {
"type": "boolean"
},
"job_scope": {
"enum": [
"all_compatible",
"selected"
],
"type": "string"
},
"starter_key": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"delivery_mode": {
"enum": [
"auto_send",
"auto_draft_review"
],
"type": "string"
},
"job_posting_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"needs_step_pick": {
"type": "boolean"
},
"pipeline_stage_id": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pipeline_template_id": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"description": "The rule as you would pass it to create.",
"additionalProperties": false
},
"rule_id": {
"type": "string",
"minLength": 1
},
"request_id": {
"type": "string",
"minLength": 1
},
"application_id": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}