Webhooks
Webhook event types
On this page
- People
- person.hired
- person.updated
- person.job_changed
- person.terminated
- person.rehired
- person.erased
- Structure
- unit.created
- unit.updated
- unit.archived
- location.created
- location.updated
- location.archived
- legal_entity.created
- legal_entity.updated
- legal_entity.archived
- Members
- member.role_changed
- member.invited
- member.joined
- Company
- features.changed
- Positions
- position.created
- position.updated
- position.filled
- Job titles
- title.created
- title.updated
- title.merged
- title.archived
- Approvals
- approval.decided
- Checklists
- checklist.started
- checklist.completed
- checklist.task.assigned
- checklist.task.status_changed
- Announcements
- announcement.published
- announcement.acknowledged
- Pay equity
- pay_report.finalised
- Documents
- document.added
- document.updated
- document.signature.updated
- document.deleted
- document.generated
- document.template.published
- document.prepared
- document.sent
- document.clause.published
- document.policy.published
- document.policy.acknowledged
- document.policy.retired
- Payroll
- payroll.period.locked
- payroll.reconciled
- payroll.export.created
- Equipment
- asset.assigned
- asset.returned
- Time off
- timeoff.booked
- timeoff.cancelled
- timeoff.decided
- Time clock
- timeclock.punched
- timeclock.corrected
- timeclock.overtime_decided
- timeclock.month_closed
- Shifts
- shifts.week.published
- shifts.request.approved
- Hiring
- hiring.job_opened
- hiring.job_closed
- hiring.application_received
- hiring.application_moved
- hiring.application_hired
- hiring.interview_booked
- hiring.interview_cancelled
- hiring.offer_sent
- hiring.offer_accepted
- hiring.offer_declined
- hiring.feedback_submitted
- Training
- training.record.created
- training.record.confirmed
- Benefits
- benefits.benefit.created
- benefits.enrolment.changed
- Surveys
- surveys.survey.opened
- surveys.survey.closed
- surveys.response.submitted
- surveys.round.closed
- Performance and talent
- talent.cycle.launched
- talent.cycle.closed
- talent.goal.updated
- talent.profile.updated
- Salary reviews
- comp.bonus_plan.released
- comp.cycle.released
Every event type, with when Bizisy sends it, the fields of data and a payload example. Choose them per endpoint in Integrations → Webhooks. Every event's data has organization_id; events about a record also carry its snapshot (public and job details only), filled in when each attempt is sent.
Integrations → Webhooks also has Send test event, which sends a webhook.test event signed like any other.
People#
person.hired#
Someone was added with their first job (start_date may be in the future). When no manager was given and the team lead became the manager, manager_source is "team_lead" and manager_lead_unit_id the team.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string | |
start_date | string | |
manager_source | "team_lead" | Only on some of these events (see the description). |
manager_lead_unit_id | string | Only on some of these events (see the description). |
person | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "person.hired",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1",
"start_date": "2026-11-02",
"manager_source": "team_lead",
"manager_lead_unit_id": "<manager_lead_unit_id>",
"person": {
"id": "p1",
"name": "Ana Ferreira",
"given_name": "Ana",
"family_name": "Ferreira",
"preferred_name": null,
"work_email": "ana@acme.test",
"work_phone": "+351 210 000 000",
"pronouns": "she/her",
"status": "active",
"start_date": "2024-01-15",
"title": "Engineer",
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
},
"job": {
"id": "j1",
"valid_from": "2024-01-15",
"valid_to": null,
"title": "Engineer",
"title_id": "t1",
"display_title": null,
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"legal_entity": {
"id": "e1",
"name": "Acme Lda"
},
"employment_type": "full_time",
"fte": 1,
"reason": "hire",
"leaving_type": null,
"told": null,
"contract_type": "fixed_term",
"contract_end_date": "2026-01-14",
"probation_end_date": "2024-07-14",
"weekly_hours": 40,
"notice_period_days": 30,
"custom": [
{
"key": "shift_pattern",
"label": "Shift pattern",
"type": "select",
"tier": "job",
"value": "Day"
}
],
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
}
},
"custom": [
{
"key": "t_shirt_size",
"label": "T-shirt size",
"type": "select",
"tier": "public",
"value": "M"
},
{
"key": "remote",
"label": "Remote allowance",
"type": "boolean",
"tier": "job",
"value": null
}
]
}
}
}person.updated#
Public or job details of a person changed: name, work email or phone, pronouns, photo, a public or job custom field, or a corrected job history row (job_id). A correction that defaulted the manager to the team lead (a CSV or org_setup_apply moving someone not started yet) carries manager_source "team_lead" and manager_lead_unit_id.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string | |
job_id | string | Only on some of these events (see the description). |
manager_source | "team_lead" | Only on some of these events (see the description). |
manager_lead_unit_id | string | Only on some of these events (see the description). |
person | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "person.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1",
"job_id": "j1",
"manager_source": "team_lead",
"manager_lead_unit_id": "<manager_lead_unit_id>",
"person": {
"id": "p1",
"name": "Ana Ferreira",
"given_name": "Ana",
"family_name": "Ferreira",
"preferred_name": null,
"work_email": "ana@acme.test",
"work_phone": "+351 210 000 000",
"pronouns": "she/her",
"status": "active",
"start_date": "2024-01-15",
"title": "Engineer",
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
},
"job": {
"id": "j1",
"valid_from": "2024-01-15",
"valid_to": null,
"title": "Engineer",
"title_id": "t1",
"display_title": null,
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"legal_entity": {
"id": "e1",
"name": "Acme Lda"
},
"employment_type": "full_time",
"fte": 1,
"reason": "hire",
"leaving_type": null,
"told": null,
"contract_type": "fixed_term",
"contract_end_date": "2026-01-14",
"probation_end_date": "2024-07-14",
"weekly_hours": 40,
"notice_period_days": 30,
"custom": [
{
"key": "shift_pattern",
"label": "Shift pattern",
"type": "select",
"tier": "job",
"value": "Day"
}
],
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
}
},
"custom": [
{
"key": "t_shirt_size",
"label": "T-shirt size",
"type": "select",
"tier": "public",
"value": "M"
},
{
"key": "remote",
"label": "Remote allowance",
"type": "boolean",
"tier": "job",
"value": null
}
]
}
}
}person.job_changed#
A job change was recorded from effective_date (title, team, manager, location, contract terms…). When no manager was given and the team lead became the manager, manager_source is "team_lead" and manager_lead_unit_id the team.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string | |
effective_date | string | |
reason | string | |
manager_source | "team_lead" | Only on some of these events (see the description). |
manager_lead_unit_id | string | Only on some of these events (see the description). |
person | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "person.job_changed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1",
"effective_date": "2026-11-01",
"reason": "promotion",
"manager_source": "team_lead",
"manager_lead_unit_id": "<manager_lead_unit_id>",
"person": {
"id": "p1",
"name": "Ana Ferreira",
"given_name": "Ana",
"family_name": "Ferreira",
"preferred_name": null,
"work_email": "ana@acme.test",
"work_phone": "+351 210 000 000",
"pronouns": "she/her",
"status": "active",
"start_date": "2024-01-15",
"title": "Engineer",
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
},
"job": {
"id": "j1",
"valid_from": "2024-01-15",
"valid_to": null,
"title": "Engineer",
"title_id": "t1",
"display_title": null,
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"legal_entity": {
"id": "e1",
"name": "Acme Lda"
},
"employment_type": "full_time",
"fte": 1,
"reason": "hire",
"leaving_type": null,
"told": null,
"contract_type": "fixed_term",
"contract_end_date": "2026-01-14",
"probation_end_date": "2024-07-14",
"weekly_hours": 40,
"notice_period_days": 30,
"custom": [
{
"key": "shift_pattern",
"label": "Shift pattern",
"type": "select",
"tier": "job",
"value": "Day"
}
],
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
}
},
"custom": [
{
"key": "t_shirt_size",
"label": "T-shirt size",
"type": "select",
"tier": "public",
"value": "M"
},
{
"key": "remote",
"label": "Remote allowance",
"type": "boolean",
"tier": "job",
"value": null
}
]
}
}
}person.terminated#
Employment ends after last_day (may be in the future).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string | |
last_day | string | |
person | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "person.terminated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1",
"last_day": "2026-12-31",
"person": {
"id": "p1",
"name": "Ana Ferreira",
"given_name": "Ana",
"family_name": "Ferreira",
"preferred_name": null,
"work_email": "ana@acme.test",
"work_phone": "+351 210 000 000",
"pronouns": "she/her",
"status": "active",
"start_date": "2024-01-15",
"title": "Engineer",
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
},
"job": {
"id": "j1",
"valid_from": "2024-01-15",
"valid_to": null,
"title": "Engineer",
"title_id": "t1",
"display_title": null,
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"legal_entity": {
"id": "e1",
"name": "Acme Lda"
},
"employment_type": "full_time",
"fte": 1,
"reason": "hire",
"leaving_type": null,
"told": null,
"contract_type": "fixed_term",
"contract_end_date": "2026-01-14",
"probation_end_date": "2024-07-14",
"weekly_hours": 40,
"notice_period_days": 30,
"custom": [
{
"key": "shift_pattern",
"label": "Shift pattern",
"type": "select",
"tier": "job",
"value": "Day"
}
],
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
}
},
"custom": [
{
"key": "t_shirt_size",
"label": "T-shirt size",
"type": "select",
"tier": "public",
"value": "M"
},
{
"key": "remote",
"label": "Remote allowance",
"type": "boolean",
"tier": "job",
"value": null
}
]
}
}
}person.rehired#
A former employee starts a new employment on start_date. When no manager was given and the team lead became the manager, manager_source is "team_lead" and manager_lead_unit_id the team.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string | |
start_date | string | |
manager_source | "team_lead" | Only on some of these events (see the description). |
manager_lead_unit_id | string | Only on some of these events (see the description). |
person | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "person.rehired",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1",
"start_date": "2026-11-02",
"manager_source": "team_lead",
"manager_lead_unit_id": "<manager_lead_unit_id>",
"person": {
"id": "p1",
"name": "Ana Ferreira",
"given_name": "Ana",
"family_name": "Ferreira",
"preferred_name": null,
"work_email": "ana@acme.test",
"work_phone": "+351 210 000 000",
"pronouns": "she/her",
"status": "active",
"start_date": "2024-01-15",
"title": "Engineer",
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
},
"job": {
"id": "j1",
"valid_from": "2024-01-15",
"valid_to": null,
"title": "Engineer",
"title_id": "t1",
"display_title": null,
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Head office"
},
"legal_entity": {
"id": "e1",
"name": "Acme Lda"
},
"employment_type": "full_time",
"fte": 1,
"reason": "hire",
"leaving_type": null,
"told": null,
"contract_type": "fixed_term",
"contract_end_date": "2026-01-14",
"probation_end_date": "2024-07-14",
"weekly_hours": 40,
"notice_period_days": 30,
"custom": [
{
"key": "shift_pattern",
"label": "Shift pattern",
"type": "select",
"tier": "job",
"value": "Day"
}
],
"manager": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
}
},
"custom": [
{
"key": "t_shirt_size",
"label": "T-shirt size",
"type": "select",
"tier": "public",
"value": "M"
},
{
"key": "remote",
"label": "Remote allowance",
"type": "boolean",
"tier": "job",
"value": null
}
]
}
}
}person.erased#
A former employee's personal data was erased: delete what you keep about them.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string |
Example payload
{
"type": "person.erased",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1"
}
}Structure#
unit.created#
A division, department or team was created.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
unit_id | string | |
unit | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "unit.created",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"unit_id": "u2",
"unit": {
"id": "u2",
"name": "Engineering",
"kind": "department",
"parent_id": "u1",
"head": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
},
"archived": false,
"member_count": 4,
"custom": [
{
"key": "cost_centre",
"label": "Cost centre",
"type": "text",
"tier": "public",
"value": "CC-100"
}
]
}
}
}unit.updated#
A unit was renamed, moved or got a new team lead (head).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
unit_id | string | |
unit | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "unit.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"unit_id": "u2",
"unit": {
"id": "u2",
"name": "Engineering",
"kind": "department",
"parent_id": "u1",
"head": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
},
"archived": false,
"member_count": 4,
"custom": [
{
"key": "cost_centre",
"label": "Cost centre",
"type": "text",
"tier": "public",
"value": "CC-100"
}
]
}
}
}unit.archived#
A unit was archived.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
unit_id | string | |
unit | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "unit.archived",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"unit_id": "u2",
"unit": {
"id": "u2",
"name": "Engineering",
"kind": "department",
"parent_id": "u1",
"head": {
"id": "p2",
"name": "Rui Costa",
"title": "CTO"
},
"archived": false,
"member_count": 4,
"custom": [
{
"key": "cost_centre",
"label": "Cost centre",
"type": "text",
"tier": "public",
"value": "CC-100"
}
]
}
}
}location.created#
A location was created.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
location_id | string | |
location | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "location.created",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"location_id": "l1",
"location": {
"id": "l1",
"name": "Head office",
"country": "PT",
"region": null,
"city": "Lisboa",
"timezone": "Europe/Lisbon",
"remote": false,
"archived": false
}
}
}location.updated#
A location changed.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
location_id | string | |
location | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "location.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"location_id": "l1",
"location": {
"id": "l1",
"name": "Head office",
"country": "PT",
"region": null,
"city": "Lisboa",
"timezone": "Europe/Lisbon",
"remote": false,
"archived": false
}
}
}location.archived#
A location was archived.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
location_id | string | |
location | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "location.archived",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"location_id": "l1",
"location": {
"id": "l1",
"name": "Head office",
"country": "PT",
"region": null,
"city": "Lisboa",
"timezone": "Europe/Lisbon",
"remote": false,
"archived": false
}
}
}legal_entity.created#
A legal entity (employing company) was created.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
legal_entity_id | string | |
legal_entity | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "legal_entity.created",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"legal_entity_id": "e1",
"legal_entity": {
"id": "e1",
"legal_name": "Acme Lda",
"country": "PT",
"tax_id": null,
"archived": false,
"address": null,
"collective_agreement": null,
"collective_agreement_code": null,
"accident_insurer": "Fidelidade",
"accident_policy": "AT-123",
"social_security": null
}
}
}legal_entity.updated#
A legal entity changed.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
legal_entity_id | string | |
legal_entity | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "legal_entity.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"legal_entity_id": "e1",
"legal_entity": {
"id": "e1",
"legal_name": "Acme Lda",
"country": "PT",
"tax_id": null,
"archived": false,
"address": null,
"collective_agreement": null,
"collective_agreement_code": null,
"accident_insurer": "Fidelidade",
"accident_policy": "AT-123",
"social_security": null
}
}
}legal_entity.archived#
A legal entity was archived.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
legal_entity_id | string | |
legal_entity | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "legal_entity.archived",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"legal_entity_id": "e1",
"legal_entity": {
"id": "e1",
"legal_name": "Acme Lda",
"country": "PT",
"tax_id": null,
"archived": false,
"address": null,
"collective_agreement": null,
"collective_agreement_code": null,
"accident_insurer": "Fidelidade",
"accident_policy": "AT-123",
"social_security": null
}
}
}Members#
member.role_changed#
A member's role changed (owner, admin, hr, viewer, member, or custom with its role_id).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
membership_id | string | |
person_id | string | null | |
role | string | |
previous_role | string | |
role_id | string | null | Only on some of these events (see the description). |
Example payload
{
"type": "member.role_changed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"membership_id": "m2",
"person_id": "p1",
"role": "member",
"previous_role": "<previous_role>",
"role_id": "<role_id>"
}
}member.invited#
A person was invited to sign in, with the role the invite grants.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string | |
role | string |
Example payload
{
"type": "member.invited",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1",
"role": "member"
}
}member.joined#
A person accepted their invite: their login exists now.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string | |
membership_id | string |
Example payload
{
"type": "member.joined",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1",
"membership_id": "m2"
}
}Company#
features.changed#
Modules (timeoff, timeclock, documents, assets, checkins, renewals, hiring, payroll, finance, analytics, pay_equity, more_integrations, bank_verification) or AI and API access (ai.manage, ai.me, api.manage, api.me) were switched on or off.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
modules_on | array | |
modules_off | array | |
access_on | array | |
access_off | array |
Example payload
{
"type": "features.changed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"modules_on": "<modules_on>",
"modules_off": "<modules_off>",
"access_on": "<access_on>",
"access_off": "<access_off>"
}
}Positions#
position.created#
An open position was opened or put on hold for the first time (drafts send nothing until they open). Never its budget or notes.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
position_id | string | |
position | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "position.created",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"position_id": "pos1",
"position": {
"id": "pos1",
"title": "Data Engineer",
"title_id": "t2",
"status": "open",
"reason": "replacement",
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Lisbon"
},
"legal_entity": {
"id": "e1",
"name": "Acme Lda"
},
"reports_to_position": null,
"contract_type": "permanent",
"weekly_hours": 40,
"target_start_date": "2026-12-01",
"filled_on": null,
"request": {
"by": {
"id": "p2",
"name": "Tomás Silva",
"title": "Engineering Manager",
"photo_url": null
},
"at": "2026-10-03T09:00:00.000Z",
"note": "Rui leaves at the end of November.",
"withdrawn": false
},
"title_description": "Builds and runs the data pipelines the company reports from.",
"custom": [
{
"key": "hiring_manager",
"label": "Hiring manager",
"type": "person",
"tier": "public",
"value": "p1",
"person": {
"id": "p1",
"name": "Ana Ferreira",
"title": "CTO",
"photo_url": null
}
}
],
"approval": null,
"created_at": "2026-10-04T10:00:00.000Z",
"updated_at": "2026-10-04T10:00:00.000Z",
"reports_to_person": {
"id": "p1",
"name": "Ana Ferreira",
"title": "CTO"
},
"filled_by": null
}
}
}position.updated#
An open position changed: its details, its status (open, on hold, cancelled, reopened) or who it reports to.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
position_id | string | |
position | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "position.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"position_id": "pos1",
"position": {
"id": "pos1",
"title": "Data Engineer",
"title_id": "t2",
"status": "open",
"reason": "replacement",
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Lisbon"
},
"legal_entity": {
"id": "e1",
"name": "Acme Lda"
},
"reports_to_position": null,
"contract_type": "permanent",
"weekly_hours": 40,
"target_start_date": "2026-12-01",
"filled_on": null,
"request": {
"by": {
"id": "p2",
"name": "Tomás Silva",
"title": "Engineering Manager",
"photo_url": null
},
"at": "2026-10-03T09:00:00.000Z",
"note": "Rui leaves at the end of November.",
"withdrawn": false
},
"title_description": "Builds and runs the data pipelines the company reports from.",
"custom": [
{
"key": "hiring_manager",
"label": "Hiring manager",
"type": "person",
"tier": "public",
"value": "p1",
"person": {
"id": "p1",
"name": "Ana Ferreira",
"title": "CTO",
"photo_url": null
}
}
],
"approval": null,
"created_at": "2026-10-04T10:00:00.000Z",
"updated_at": "2026-10-04T10:00:00.000Z",
"reports_to_person": {
"id": "p1",
"name": "Ana Ferreira",
"title": "CTO"
},
"filled_by": null
}
}
}position.filled#
Someone was hired into an open position (person_id; person.hired is sent too).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
position_id | string | |
person_id | string | |
position | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "position.filled",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"position_id": "pos1",
"person_id": "p1",
"position": {
"id": "pos1",
"title": "Data Engineer",
"title_id": "t2",
"status": "open",
"reason": "replacement",
"unit": {
"id": "u2",
"name": "Engineering"
},
"location": {
"id": "l1",
"name": "Lisbon"
},
"legal_entity": {
"id": "e1",
"name": "Acme Lda"
},
"reports_to_position": null,
"contract_type": "permanent",
"weekly_hours": 40,
"target_start_date": "2026-12-01",
"filled_on": null,
"request": {
"by": {
"id": "p2",
"name": "Tomás Silva",
"title": "Engineering Manager",
"photo_url": null
},
"at": "2026-10-03T09:00:00.000Z",
"note": "Rui leaves at the end of November.",
"withdrawn": false
},
"title_description": "Builds and runs the data pipelines the company reports from.",
"custom": [
{
"key": "hiring_manager",
"label": "Hiring manager",
"type": "person",
"tier": "public",
"value": "p1",
"person": {
"id": "p1",
"name": "Ana Ferreira",
"title": "CTO",
"photo_url": null
}
}
],
"approval": null,
"created_at": "2026-10-04T10:00:00.000Z",
"updated_at": "2026-10-04T10:00:00.000Z",
"reports_to_person": {
"id": "p1",
"name": "Ana Ferreira",
"title": "CTO"
},
"filled_by": null
}
}
}Job titles#
title.created#
A job title was added to the catalog with org_titles_create (titles typed in a hire or job change arrive with the person event).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
title_id | string | |
title | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "title.created",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"title_id": "<title_id>",
"title": null
}
}title.updated#
A job title was renamed (the new name applies to everyone holding it, history included), restored, or its family, track, level or description changed.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
title_id | string | |
title | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "title.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"title_id": "<title_id>",
"title": null
}
}title.merged#
A job title was merged into another (into_id): everyone holding it now shows that title.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
title_id | string | |
into_id | string | |
title | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "title.merged",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"title_id": "<title_id>",
"into_id": "<into_id>",
"title": null
}
}title.archived#
A job title was archived: nobody new gets it; people who hold it keep it.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
title_id | string | |
title | object | null | The record as it is when the attempt is sent: public and job details only. null when it no longer exists. |
Example payload
{
"type": "title.archived",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"title_id": "<title_id>",
"title": null
}
}Approvals#
approval.decided#
A job change or termination request was approved (the change applied: its person event is sent too) or rejected (status). Nothing is sent while a request waits or when it is withdrawn; pay change requests send no webhook.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
approval_id | string | |
person_id | string | |
kind | "job_change" | "termination" | |
status | "approved" | "rejected" |
Example payload
{
"type": "approval.decided",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"approval_id": "ap1",
"person_id": "p1",
"kind": "job_change",
"status": "approved"
}
}Checklists#
checklist.started#
An onboarding, offboarding or custom checklist started for a person (run_id, person_id, kind).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
run_id | string | |
person_id | string | |
kind | "onboarding" | "offboarding" | "custom" |
Example payload
{
"type": "checklist.started",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"run_id": "r1",
"person_id": "p1",
"kind": "onboarding"
}
}checklist.completed#
Every task of a checklist is done or skipped (run_id, person_id, kind).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
run_id | string | |
person_id | string | |
kind | "onboarding" | "offboarding" | "custom" |
Example payload
{
"type": "checklist.completed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"run_id": "r1",
"person_id": "p1",
"kind": "onboarding"
}
}checklist.task.assigned#
A checklist task got who does it: every task when its checklist starts, and when a task is reassigned (run_id, task_id, person_id: whom the checklist is about, kind, assignee_type: hr | manager | person | member, assignee_person_id: null for hr).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
run_id | string | |
task_id | string | |
person_id | string | |
kind | "onboarding" | "offboarding" | "custom" | |
assignee_type | "hr" | "manager" | "person" | "member" | |
assignee_person_id | string | null |
Example payload
{
"type": "checklist.task.assigned",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"run_id": "r1",
"task_id": "<task_id>",
"person_id": "p1",
"kind": "onboarding",
"assignee_type": "hr",
"assignee_person_id": "<assignee_person_id>"
}
}checklist.task.status_changed#
A checklist task was ticked, skipped or reopened (status, previous_status), in Bizisy or in the tool it was delegated to (source: bizisy, or the tool: jira, linear, asana, monday, clickup, microsoft_todo, microsoft_planner, trello, notion, freshservice, zendesk or servicenow). Ids only, never comments or skip reasons.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
run_id | string | |
task_id | string | |
person_id | string | |
kind | "onboarding" | "offboarding" | "custom" | |
status | "open" | "done" | "skipped" | |
previous_status | "open" | "done" | "skipped" | |
source | "bizisy" | "jira" | "linear" | "asana" | "monday" | "clickup" | "microsoft_todo" | "microsoft_planner" | "trello" | "notion" | "freshservice" | "zendesk" | "servicenow" | "talentlms" | "learning360" | "docebo" | "moodle" | "linkedin_learning" |
Example payload
{
"type": "checklist.task.status_changed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"run_id": "r1",
"task_id": "<task_id>",
"person_id": "p1",
"kind": "onboarding",
"status": "open",
"previous_status": "open",
"source": "bizisy"
}
}Announcements#
announcement.published#
An announcement was published (announcement_id, how many people it reaches, whether it asks them to confirm they read it). Never its title, text or audience: read it in Bizisy.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
announcement_id | string | |
recipients | integer | |
requires_ack | boolean |
Example payload
{
"type": "announcement.published",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"announcement_id": "<announcement_id>",
"recipients": "<recipients>",
"requires_ack": "<requires_ack>"
}
}announcement.acknowledged#
Someone confirmed they read an announcement (announcement_id, person_id, via app or kiosk), once per person.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
announcement_id | string | |
person_id | string | |
via | "app" | "kiosk" |
Example payload
{
"type": "announcement.acknowledged",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"announcement_id": "<announcement_id>",
"person_id": "p1",
"via": "app"
}
}Pay equity#
pay_report.finalised#
A pay gap report (EU Pay Transparency Directive Art. 9) was finalised for a legal entity and year: report_id, legal_entity_id and year only; read the figures in Bizisy (they are pay data).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
report_id | string | |
legal_entity_id | string | |
year | integer |
Example payload
{
"type": "pay_report.finalised",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"report_id": "<report_id>",
"legal_entity_id": "e1",
"year": "<year>"
}
}Documents#
document.added#
A company or person document was added (document_id, subject, person_id). Never its title, file name or category.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
document_id | string | |
subject | "person" | "company" | |
person_id | string | null |
Example payload
{
"type": "document.added",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"document_id": "d1",
"subject": "person",
"person_id": "p1"
}
}document.updated#
A document's details or who can see it changed (document_id, subject, person_id).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
document_id | string | |
subject | "person" | "company" | |
person_id | string | null |
Example payload
{
"type": "document.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"document_id": "d1",
"subject": "person",
"person_id": "p1"
}
}document.signature.updated#
A signature request (through the e-signature tool) was sent, finished, declined, expired, canceled or could not be sent (signature_id, document_id, person_id, status). Never the signers' names.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
signature_id | string | |
document_id | string | |
person_id | string | null | |
status | "queued" | "sending" | "ongoing" | "done" | "declined" | "expired" | "canceled" | "failed" |
Example payload
{
"type": "document.signature.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"signature_id": "<signature_id>",
"document_id": "d1",
"person_id": "p1",
"status": "queued"
}
}document.deleted#
A document and its file were deleted (document_id, subject, person_id). Delete any copy you keep.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
document_id | string | |
subject | "person" | "company" | |
person_id | string | null |
Example payload
{
"type": "document.deleted",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"document_id": "d1",
"subject": "person",
"person_id": "p1"
}
}document.generated#
A document was made from a template for a person (document_id, person_id, template_id, version). Never its title or contents.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
document_id | string | |
person_id | string | |
template_id | string | |
version | integer |
Example payload
{
"type": "document.generated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"document_id": "d1",
"person_id": "p1",
"template_id": "<template_id>",
"version": "<version>"
}
}document.template.published#
A document template version was published (template_id, version).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
template_id | string | |
version | integer |
Example payload
{
"type": "document.template.published",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"template_id": "<template_id>",
"version": "<version>"
}
}document.prepared#
Bizisy prepared a document for HR to review: a written statement at hire, a change notice, or a statement someone asked for (prepared_id, person_id, kind). Never its contents.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
prepared_id | string | |
person_id | string | |
kind | string |
Example payload
{
"type": "document.prepared",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"prepared_id": "<prepared_id>",
"person_id": "p1",
"kind": "<kind>"
}
}document.sent#
A prepared document was sent to the person (prepared_id, document_id, person_id, kind). Never its contents.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
prepared_id | string | |
document_id | string | |
person_id | string | |
kind | string |
Example payload
{
"type": "document.sent",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"prepared_id": "<prepared_id>",
"document_id": "d1",
"person_id": "p1",
"kind": "<kind>"
}
}document.clause.published#
A contract clause version was published in the clause library (clause_id, version). Never its text.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
clause_id | string | |
version | integer |
Example payload
{
"type": "document.clause.published",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"clause_id": "<clause_id>",
"version": "<version>"
}
}document.policy.published#
A policy (or a new version of it) was published to staff to acknowledge (policy_id, version, template_id). Never its text.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
policy_id | string | |
version | integer | |
template_id | string |
Example payload
{
"type": "document.policy.published",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"policy_id": "<policy_id>",
"version": "<version>",
"template_id": "<template_id>"
}
}document.policy.acknowledged#
A person acknowledged a version of a policy (policy_id, version, person_id). Never the name they typed.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
policy_id | string | |
version | integer | |
person_id | string |
Example payload
{
"type": "document.policy.acknowledged",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"policy_id": "<policy_id>",
"version": "<version>",
"person_id": "p1"
}
}document.policy.retired#
A policy was retired: nobody is asked to acknowledge it any more (policy_id).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
policy_id | string |
Example payload
{
"type": "document.policy.retired",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"policy_id": "<policy_id>"
}
}Payroll#
payroll.period.locked#
A pay period was locked and is ready to export (period_id, legal_entity_id, start, end). Read it with payroll_periods_get.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
period_id | string | |
legal_entity_id | string | |
start | string | |
end | string |
Example payload
{
"type": "payroll.period.locked",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"period_id": "<period_id>",
"legal_entity_id": "e1",
"start": "<start>",
"end": "<end>"
}
}payroll.reconciled#
A pay period was reconciled with Meta4's results (period_id, export_id and counts: matched, different, not_in_meta4, only_in_meta4, ignored, unknown). Never people or values: read them with payroll_reconcile_get.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
period_id | string | |
export_id | string | |
matched | integer | |
different | integer | |
not_in_meta4 | integer | |
only_in_meta4 | integer | |
ignored | integer | |
unknown | integer |
Example payload
{
"type": "payroll.reconciled",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"period_id": "<period_id>",
"export_id": "<export_id>",
"matched": "<matched>",
"different": "<different>",
"not_in_meta4": "<not_in_meta4>",
"only_in_meta4": "<only_in_meta4>",
"ignored": "<ignored>",
"unknown": "<unknown>"
}
}payroll.export.created#
A payroll export was created (export_id, period_id, format). Never its content: download it with payroll_exports_download.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
export_id | string | |
period_id | string | |
format | string |
Example payload
{
"type": "payroll.export.created",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"export_id": "<export_id>",
"period_id": "<period_id>",
"format": "<format>"
}
}Equipment#
asset.assigned#
A piece of equipment was handed to a person (asset_id, person_id, since). Never its value, serial or notes.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
asset_id | string | |
person_id | string | |
since | string |
Example payload
{
"type": "asset.assigned",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"asset_id": "<asset_id>",
"person_id": "p1",
"since": "<since>"
}
}asset.returned#
A person gave a piece of equipment back, or it moved to someone else (asset_id, person_id, on).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
asset_id | string | |
person_id | string | |
on | string |
Example payload
{
"type": "asset.returned",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"asset_id": "<asset_id>",
"person_id": "p1",
"on": "<on>"
}
}Time off#
timeoff.booked#
Someone will be away: days were booked (at once, or when a request was approved). request_id, person_id, start, end, start_part and end_part (full, am, pm, or hours: away part of one day, never how long or when). Never the leave type, the note, or requests still waiting for a decision.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
request_id | string | |
person_id | string | |
start | string | |
end | string | |
start_part | "full" | "am" | "pm" | "hours" | |
end_part | "full" | "am" | "pm" | "hours" | |
status | "approved" |
Example payload
{
"type": "timeoff.booked",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"request_id": "<request_id>",
"person_id": "p1",
"start": "<start>",
"end": "<end>",
"start_part": "full",
"end_part": "full",
"status": "approved"
}
}timeoff.cancelled#
A booking or request was cancelled (request_id, person_id, start, end). Never the leave type or the note.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
request_id | string | |
person_id | string | |
start | string | |
end | string |
Example payload
{
"type": "timeoff.cancelled",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"request_id": "<request_id>",
"person_id": "p1",
"start": "<start>",
"end": "<end>"
}
}timeoff.decided#
A request was approved (request_id, person_id, start, end, decision approved). Declined requests are never announced; never the leave type or the note.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
request_id | string | |
person_id | string | |
start | string | |
end | string | |
decision | "approved" |
Example payload
{
"type": "timeoff.decided",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"request_id": "<request_id>",
"person_id": "p1",
"start": "<start>",
"end": "<end>",
"decision": "approved"
}
}Time clock#
timeclock.punched#
Someone clocked in, out, or started or ended a break (punch_id, person_id, kind), sent as it happens: an endpoint learns roughly when people clock. The payload never carries the time, the place or the location.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
punch_id | string | |
person_id | string | |
kind | "in" | "out" | "break_start" | "break_end" |
Example payload
{
"type": "timeclock.punched",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"punch_id": "<punch_id>",
"person_id": "p1",
"kind": "in"
}
}timeclock.corrected#
A correction of someone's time records was applied (correction_id, person_id, day). Never the times or the reason.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
correction_id | string | |
person_id | string | |
day | string |
Example payload
{
"type": "timeclock.corrected",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"correction_id": "<correction_id>",
"person_id": "p1",
"day": "<day>"
}
}timeclock.overtime_decided#
Overtime for someone was approved, declined (not overtime, when already worked) or withdrawn (overtime_id, person_id, day, status). Never the minutes or the reason.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
overtime_id | string | |
person_id | string | |
day | string | |
status | "approved" | "declined" | "cancelled" |
Example payload
{
"type": "timeclock.overtime_decided",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"overtime_id": "<overtime_id>",
"person_id": "p1",
"day": "<day>",
"status": "approved"
}
}timeclock.month_closed#
HR closed a month of someone's time records (person_id, month YYYY-MM). Never the totals.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string | |
month | string |
Example payload
{
"type": "timeclock.month_closed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1",
"month": "<month>"
}
}Shifts#
shifts.week.published#
A rota week was published or published again (rota_id, week as an ISO week such as 2026-W47, version). Never who works when, notes or reasons: read the week in Bizisy.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
rota_id | string | |
week | string | |
version | integer |
Example payload
{
"type": "shifts.week.published",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"rota_id": "<rota_id>",
"week": "<week>",
"version": "<version>"
}
}shifts.request.approved#
A shift swap, give-away or claim was approved and the published week changed (request_id, rota_id, week, kind). Never names, times or messages.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
request_id | string | |
rota_id | string | |
week | string | |
kind | "swap" | "give_away" | "claim" |
Example payload
{
"type": "shifts.request.approved",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"request_id": "<request_id>",
"rota_id": "<rota_id>",
"week": "<week>",
"kind": "swap"
}
}Hiring#
hiring.job_opened#
A job was opened (or reopened) on the careers page: job_id, position_id and its public fields (title, slug, employment type, workplace, city, country).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
job_id | string | |
position_id | string | null | |
title | string | |
slug | string | |
employment_type | string | |
workplace | string | |
city | string | null | |
country | string | null | |
audience | "public" | "internal_first" | "internal_only" | Only on some of these events (see the description). |
Example payload
{
"type": "hiring.job_opened",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"job_id": "j1",
"position_id": "pos1",
"title": "<title>",
"slug": "<slug>",
"employment_type": "<employment_type>",
"workplace": "<workplace>",
"city": "<city>",
"country": "<country>",
"audience": "public"
}
}hiring.job_closed#
A published job was closed (job_id, position_id, reason: filled, cancelled or other). Filling or cancelling its position closes it too.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
job_id | string | |
position_id | string | null | |
reason | "filled" | "cancelled" | "other" |
Example payload
{
"type": "hiring.job_closed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"job_id": "j1",
"position_id": "pos1",
"reason": "promotion"
}
}hiring.application_received#
Someone applied to a job (application_id, job_id, candidate_id, source). Never the candidate's name, email, CV or answers.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
application_id | string | |
job_id | string | |
candidate_id | string | |
source | string |
Example payload
{
"type": "hiring.application_received",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"application_id": "<application_id>",
"job_id": "j1",
"candidate_id": "<candidate_id>",
"source": "<source>"
}
}hiring.application_moved#
An application moved between pipeline steps (application_id, job_id, candidate_id, from and to step ids). Never notes or feedback.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
application_id | string | |
job_id | string | |
candidate_id | string | |
from | string | |
to | string |
Example payload
{
"type": "hiring.application_moved",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"application_id": "<application_id>",
"job_id": "j1",
"candidate_id": "<candidate_id>",
"from": "<from>",
"to": "<to>"
}
}hiring.application_hired#
A candidate was hired (application_id, job_id, candidate_id, and the person_id of their new record in People).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
application_id | string | |
job_id | string | |
candidate_id | string | |
person_id | string |
Example payload
{
"type": "hiring.application_hired",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"application_id": "<application_id>",
"job_id": "j1",
"candidate_id": "<candidate_id>",
"person_id": "p1"
}
}hiring.interview_booked#
An interview was booked with a candidate, by the hiring team or by the candidate picking an offered time, or moved to a new time (rescheduled true): interview_id, application_id, job_id, candidate_id, step_id. Never names, times or places.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
interview_id | string | |
application_id | string | |
job_id | string | |
candidate_id | string | |
step_id | string | |
rescheduled | boolean |
Example payload
{
"type": "hiring.interview_booked",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"interview_id": "<interview_id>",
"application_id": "<application_id>",
"job_id": "j1",
"candidate_id": "<candidate_id>",
"step_id": "<step_id>",
"rescheduled": "<rescheduled>"
}
}hiring.interview_cancelled#
A booked interview was cancelled by the hiring team or the candidate (by: team or candidate): interview_id, application_id, job_id, candidate_id, step_id.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
interview_id | string | |
application_id | string | |
job_id | string | |
candidate_id | string | |
step_id | string | |
by | "team" | "candidate" |
Example payload
{
"type": "hiring.interview_cancelled",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"interview_id": "<interview_id>",
"application_id": "<application_id>",
"job_id": "j1",
"candidate_id": "<candidate_id>",
"step_id": "<step_id>",
"by": "team"
}
}hiring.offer_sent#
An offer was sent to a candidate (offer_id, version, application_id, job_id, candidate_id). Never the terms, the pay or names.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
offer_id | string | |
version | integer | |
application_id | string | |
job_id | string | |
candidate_id | string |
Example payload
{
"type": "hiring.offer_sent",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"offer_id": "<offer_id>",
"version": "<version>",
"application_id": "<application_id>",
"job_id": "j1",
"candidate_id": "<candidate_id>"
}
}hiring.offer_accepted#
A candidate accepted an offer on their offer page (offer_id, version, application_id, job_id, candidate_id); the hire follows (hiring.application_hired). Never the terms, the pay or names.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
offer_id | string | |
version | integer | |
application_id | string | |
job_id | string | |
candidate_id | string |
Example payload
{
"type": "hiring.offer_accepted",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"offer_id": "<offer_id>",
"version": "<version>",
"application_id": "<application_id>",
"job_id": "j1",
"candidate_id": "<candidate_id>"
}
}hiring.offer_declined#
A candidate declined an offer (offer_id, version, application_id, job_id, candidate_id). Never the reason, the terms or names.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
offer_id | string | |
version | integer | |
application_id | string | |
job_id | string | |
candidate_id | string |
Example payload
{
"type": "hiring.offer_declined",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"offer_id": "<offer_id>",
"version": "<version>",
"application_id": "<application_id>",
"job_id": "j1",
"candidate_id": "<candidate_id>"
}
}hiring.feedback_submitted#
An interviewer sent their feedback on an interview: feedback_id, interview_id, application_id, job_id, candidate_id, step_id. Never who wrote it, the ratings, the words or the recommendation.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
feedback_id | string | |
interview_id | string | |
application_id | string | |
job_id | string | |
candidate_id | string | |
step_id | string |
Example payload
{
"type": "hiring.feedback_submitted",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"feedback_id": "<feedback_id>",
"interview_id": "<interview_id>",
"application_id": "<application_id>",
"job_id": "j1",
"candidate_id": "<candidate_id>",
"step_id": "<step_id>"
}
}Training#
training.record.created#
A training record was added for a person: by HR, an import, a learning tool or the person's own report (record_id, person_id, course_id). Never hours, titles or certificates.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
record_id | string | |
person_id | string | |
course_id | string | null |
Example payload
{
"type": "training.record.created",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"record_id": "<record_id>",
"person_id": "p1",
"course_id": "<course_id>"
}
}training.record.confirmed#
A training record counts: HR confirmed a person's report, or HR, an import or a learning tool recorded it (record_id, person_id, course_id).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
record_id | string | |
person_id | string | |
course_id | string | null |
Example payload
{
"type": "training.record.confirmed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"record_id": "<record_id>",
"person_id": "p1",
"course_id": "<course_id>"
}
}Benefits#
benefits.benefit.created#
A benefit was added to the catalogue (benefit_id). Never its amounts.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
benefit_id | string |
Example payload
{
"type": "benefits.benefit.created",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"benefit_id": "<benefit_id>"
}
}benefits.enrolment.changed#
A person's benefit choices changed (person_id). Never which benefits, the amounts or what was chosen.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string |
Example payload
{
"type": "benefits.enrolment.changed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1"
}
}Surveys#
surveys.survey.opened#
A survey opened and was sent (survey_id, mode, how many people it went to). Never its questions or answers.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
survey_id | string | |
mode | "named" | "confidential" | "anonymous" | |
recipients | integer |
Example payload
{
"type": "surveys.survey.opened",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"survey_id": "<survey_id>",
"mode": "named",
"recipients": "<recipients>"
}
}surveys.survey.closed#
A survey closed (survey_id, mode). Read its results with surveys_results_get.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
survey_id | string | |
mode | "named" | "confidential" | "anonymous" |
Example payload
{
"type": "surveys.survey.closed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"survey_id": "<survey_id>",
"mode": "named"
}
}surveys.response.submitted#
Someone sent their answers to a named survey (survey_id, response_id, person_id, submitted_at). Never sent for confidential or anonymous surveys; never the answers themselves (read them with surveys_results_responses).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
survey_id | string | |
response_id | string | |
person_id | string | |
submitted_at | string |
Example payload
{
"type": "surveys.response.submitted",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"survey_id": "<survey_id>",
"response_id": "<response_id>",
"person_id": "p1",
"submitted_at": "<submitted_at>"
}
}surveys.round.closed#
A survey (or a round of a recurring one) closed, with its released aggregates: sent_to, respondents, results_include and eNPS, each null when the results screen hides it (confidential surveys under the threshold).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
survey_id | string | |
series_id | string | null | |
round_no | integer | |
mode | "named" | "confidential" | "anonymous" | |
sent_to | integer | |
respondents | integer | null | |
results_include | integer | null | |
enps | number | null |
Example payload
{
"type": "surveys.round.closed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"survey_id": "<survey_id>",
"series_id": "<series_id>",
"round_no": "<round_no>",
"mode": "named",
"sent_to": "<sent_to>",
"respondents": "<respondents>",
"results_include": "<results_include>",
"enps": "<enps>"
}
}Performance and talent#
talent.cycle.launched#
A review cycle was launched (cycle_id). Never who is in it, answers or ratings.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
cycle_id | string |
Example payload
{
"type": "talent.cycle.launched",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"cycle_id": "<cycle_id>"
}
}talent.cycle.closed#
A review cycle was closed (cycle_id).
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
cycle_id | string |
Example payload
{
"type": "talent.cycle.closed",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"cycle_id": "<cycle_id>"
}
}talent.goal.updated#
A company or team goal was created, changed or had its progress updated (goal_id, level). Person goals never send this.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
goal_id | string | |
level | "company" | "team" |
Example payload
{
"type": "talent.goal.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"goal_id": "<goal_id>",
"level": "company"
}
}talent.profile.updated#
A person's talent profile changed: headline, visibility, or an education, certificate or experience entry added, changed, removed or verified (person_id). Never what changed.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
person_id | string |
Example payload
{
"type": "talent.profile.updated",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"person_id": "p1"
}
}Salary reviews#
comp.bonus_plan.released#
A bonus plan was released: letters went out and awards went to payroll or to be paid by hand (plan_id, released and skipped counts). Never who or amounts.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
plan_id | string | |
released | integer | |
skipped | integer |
Example payload
{
"type": "comp.bonus_plan.released",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"plan_id": "<plan_id>",
"released": "<released>",
"skipped": "<skipped>"
}
}comp.cycle.released#
A salary review was released: letters went out and the new pay was written (cycle_id, released and skipped counts). Never who, amounts or ratings.
data field | Type | Notes |
|---|---|---|
organization_id | string | Your company's id. |
cycle_id | string | |
released | integer | |
skipped | integer |
Example payload
{
"type": "comp.cycle.released",
"timestamp": "2026-10-05T10:00:00.000Z",
"data": {
"organization_id": "01k5q8m2v3c4d5e6f7g8h9j0ka",
"cycle_id": "<cycle_id>",
"released": "<released>",
"skipped": "<skipped>"
}
}Something missing or wrong on this page? Write to hello@bizisy.com.