Event Payload
Background Checks
bgcheck.result.available
Triggered when a background check is completed.
{
"data": {
"meta": {
"event_type": "bgcheck.result.available",
"event_type_id": "af7ce5be-d404-4788-aed5-9a5fce1b66c8",
"organization_id": "987deccd-cef2-4c0f-a068-7cb07971bcfe",
"organization_name": "Deel",
"tracking_id": "q8tVRj_Je00wJLY2GriqT10nUjBZ"
},
"resource": {
"candidate_email": "[email protected]",
"completed_at": "2024-09-05T08:32:51. 658Z",
"contract_id": "3072cm7",
"created_at": "2024-09-05T08:28:24.394Z",
"id": "d1f5e39c-fcfd-4f08-b5fa-66ce7112ffef",
"is_complete": true,
"name": "Softcheck",
"package": null,
"result": "CLEARED",
"status": "COMPLETE",
"third party_name": "request softcheck"
}
},
"timestamp": "2024-09-05T08:32:52. 119Z"
}
Contract Events
contract.status.updated
Triggered when a contract status changes.
{
"data": {
"meta": {
"event_type": "contract.status.updated",
"event_type_id": 3,
"organization_id": 112546,
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "-A3hBP_Bhn48yZWj9FHhpiAV5aM0",
"user_id": 593021
},
"resource": {
"client": {
"email": "[email protected]",
"full_name": "John Snow",
"id": 725379,
"legal_entity": {
"email": "",
"id": 105719,
"name": "Deel UK",
"registration_number": "12345678",
"subtype": "general-partnership",
"type": "company",
"vat_number": ""
},
"team": {
"id": 214286,
"name": "Deel EOR"
}
},
"compensation_details": {
"amount": "123",
"currency_code": "USD",
"first_payment": "",
"first_payment_date": "2023-05-30T19:29:59.999Z",
"frequency": "monthly",
"gross_annual_salary": "",
"gross_signing_bonus": "",
"gross_variable_bonus": "",
"scale": "weekly"
},
"created_at": "2023-05-11T12:21:36.684Z",
"custom_fields": [],
"employment_details": {
"days_per_week": 0,
"hours_per_day": 0,
"paid_vacation_days": 0,
"probation_period": 0,
"type": "pay_as_you_go_time_based"
},
"external_id": null,
"id": "3w4zdd9",
"invitations": {
"client_email": "[email protected]",
"worker_email": "[email protected]"
},
"is_archived": false,
"job_title": "Director",
"notice_period": 10,
"scope_of_work": "do this, do that!",
"seniority": {
"id": 1,
"level": 1,
"name": "Junior (Individual Contributor Level 1)"
},
"signatures": {
"client_signature": "signature",
"client_signed_at": "2023-05-11T12:21:42.434Z",
"signed_at": "2023-05-11T12:21:46.667Z",
"worker_signature": "signature",
"worker_signed_at": "2023-05-11T12:21:46.667Z"
},
"special_clause": "",
"start_date": "2023-05-03T19:30:00.000Z",
"status": "in_progress",
"termination_date": "2023-10-08T19:29:59.999Z",
"title": "TEST payg time-based 2023-05-11T12:21:33.709Z",
"type": "pay_as_you_go_time_based",
"who_reports": "both",
"worker": {
"alternate_email": [],
"date_of_birth": "",
"email": "[email protected]",
"expected_email": "[email protected]",
"first_name": "John",
"full_name": "Doe",
"id": 623521,
"last_name": "Doe",
"nationality": null
}
}
},
"timestamp": "2023-05-11T12:22:21.423Z"
}
contract.terminated
Triggered when a contract is terminated.
{
"data": {
"meta": {
"event_type": "contract.terminated",
"event_type_id": 4,
"organization_id": "181398",
"organization_name": "Wayne Enterprise",
"serviceVersion": "0.4.4",
"tracking_id": "DOf_g5_sLmrlzsFVFcfseSKZaJYg",
"user_id": 826902
},
"resource": {
"completion_date": "2023-05-10T12:06:28.806Z",
"id": "3r6j5pp"
}
},
"timestamp": "2023-05-10T12:06:51.947Z"
}
contract.created
Triggered when a new contract is created.
{
"data": {
"meta": {
"event_type": "contract.created",
"event_type_id": 1,
"organization_id": 112546,
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "FmbhqH_T-LUJCakw_dUWcsj6nf7V",
"user_id": 693316
},
"resource": {
"client": null,
"compensation_details": {
"amount": "123",
"currency_code": "USD",
"first_payment": "",
"first_payment_date": "2023-05-30T19:29:59.999Z",
"frequency": "monthly",
"gross_annual_salary": "",
"gross_signing_bonus": "",
"gross_variable_bonus": "",
"scale": "weekly"
},
"created_at": "2023-05-10T23:57:16.248Z",
"custom_fields": [],
"employment_details": {
"days_per_week": 0,
"hours_per_day": 0,
"paid_vacation_days": 0,
"probation_period": 0,
"type": "pay_as_you_go_time_based"
},
"external_id": null,
"id": "meq8zvz",
"invitations": {
"client_email": "",
"worker_email": ""
},
"is_archived": false,
"job_title": "Director",
"notice_period": 10,
"scope_of_work": "do this, do that!",
"seniority": {
"id": 1,
"level": 1,
"name": "Junior (Individual Contributor Level 1)"
},
"signatures": {
"client_signature": "",
"client_signed_at": "",
"signed_at": "",
"worker_signature": "",
"worker_signed_at": ""
},
"special_clause": "",
"start_date": "2023-05-02T19:30:00.000Z",
"status": "waiting_for_client_sign",
"termination_date": "2023-10-07T19:29:59.999Z",
"title": "TEST payg time-based 2023-05-10T23:57:13.772Z",
"type": "pay_as_you_go_time_based",
"who_reports": "both",
"worker": null
}
},
"timestamp": "2023-05-10T23:57:49.274Z"
}
contract.archived
Triggered when a contract is archived.
{
"data": {
"meta": {
"event_type": "contract.archived",
"event_type_id": 3,
"organization_id": 112546,
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "7_ShBg_Oosa87EivVHu0yKub8roN",
"user_id": 693316
},
"resource": {
"client": {
"team": {
"id": 214286,
"name": "Deel EOR"
}
},
"created_at": "2023-05-09T14:16:02.574Z",
"external_id": null,
"id": "3rgvkj6",
"invitations": {
"client_email": "[email protected]",
"worker_email": ""
},
"is_archived": false,
"notice_period": 10,
"signatures": {
"client_signed_at": "2023-05-09T14:16:04.512Z",
"worker_signature": "",
"worker_signed_at": ""
},
"status": "waiting_for_contractor_sign",
"termination_date": "2023-10-06T19:29:59.999Z",
"title": "TEST payg time-based 2023-05-09T14:15:59.317Z",
"type": "pay_as_you_go_time_based",
"who_reports": "both",
"worker": {
"alternate_email": [],
"date_of_birth": "",
"email": "[email protected]",
"expected_email": "[email protected]",
"first_name": "John",
"full_name": "John Snow",
"id": 623521,
"last_name": "Snow",
"nationality": null
}
}
},
"timestamp": "2023-05-09T14:16:11.394Z"
}
eor.quote.created
{
"data": {
"meta": {
"event_type": "eor.quote.created",
"event_type_id": "d3m0d3m0-d3m0-d3m0-d3m0-d3m0d3m0d3m0",
"organization_id": "d3m0d3m0-d3m0-d3m0-d3m0-d3m0d3m0d3m0",
"organization_name": "API Integration Account",
"tracking_id": "abcdefg1234567890abdcefg1234567"
},
"resource": {
"annual_salary": "300000.00",
"breakdown_costs": {
"monthly": {
"costs": [
{
"currency": "INR",
"name": "Employees' Deposit Linked Insurance (EDLI)",
"total": "75.00",
"total_usd": "0.91"
},
{
"currency": "INR",
"name": "Employee's Provident Fund (EPF)",
"total": "1800.00",
"total_usd": "21.74"
},
{
"currency": "INR",
"name": "Provident Fund Office EPF Admin Fee",
"total": "75.00",
"total_usd": "0.91"
}
],
"total": "1950.00",
"total_usd": "23.56"
}
},
"cba_total": "0.00",
"cba_total_usd": "0.00",
"contract_id": "d3m0d3m",
"contract_name": "Michael Scott - Regional Manager",
"country_name": "India",
"created_at": "2024-11-07T13:16:25.747Z",
"currency": "INR",
"employer_cost_total": "1950.00",
"employer_cost_total_usd": "23.56",
"gross_salary_total": null,
"gross_salary_total_usd": "25000.00",
"mobility_fee_total": null,
"mobility_fee_total_usd": null,
"monthly_cost_total": "68636.66",
"monthly_cost_total_usd": "829.15",
"platform_fee_total": "40644.99",
"platform_fee_total_usd": "491.00",
"recurring_allowance_total": "0.00",
"recurring_allowance_total_usd": "0.00",
"salary_total": "25000.00",
"salary_total_usd": "302.01",
"severance_accrual_total": "1041.67",
"severance_accrual_total_usd": "0.00",
"updated_at": "2024-11-07T13:16:25.747Z"
}
},
"timestamp": "2024-11-07T13:22:47.823Z"
}
Invoice Adjustments
invoice-adjustment.created
Triggered when a new invoice adjustment is created.
{
"data": {
"meta": {
"event_type": "invoice-adjustment.created",
"event_type_id": 14,
"organization_id": 112546,
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "bUyZUj_OvWu-8lhridIJuwvV8GiX",
"user_id": 693316
},
"resource": {
"created": true,
"created_at": "2023-05-11T11:10:31.619Z",
"id": 10443248,
"public_id": "dc9a59e0-dd11-4c48-848d-0edc7465fa8b",
"status": "pending"
}
},
"timestamp": "2023-05-11T11:11:04.267Z"
}
invoice-adjustment.reviewed
Triggered when an invoice adjustment is approved or denied.
{
"data": {
"meta": {
"event_type": "invoice-adjustment.reviewed",
"event_type_id": 16,
"organization_id": 112546,
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "XGkYdz_DI8Q0McMyv26fshvQf139",
"user_id": 693316
},
"resource": [
{
"id": 10443248,
"public_id": "dc9a59e0-dd11-4c48-848d-0edc7465fa8b",
"status": "approved"
}
]
},
"timestamp": "2023-05-11T11:15:51.626Z"
}
Profile
profile.kyc.changed
Triggered when Profile KYC is changed
{
"data": {
"meta": {
"event_type": "profile.kyc.changed",
"event_type_id": "1df106cd-2683-476f-9414-901efc48f6b3",
"organization_id": "1ef106cd-2683-476f-9414-901efc48f6b3",
"organization_name": "Deel",
"serviceVersion": "2.0.1",
"tracking_id": "xGt7b5_uCVenTFN_88IsU52ztxXg"
},
"resource": {
"email": "[email protected]",
"first_name": "John",
"hris_profile_id": 516707,
"kyc_status": "rejected",
"last_name": "Doe",
"middle_name": null,
"profile_id": "1cf106ed-2683-476f-9414-701efc48f6b3",
"profile_type": "contractor"
}
},
"timestamp": "2023-05-25T08:44:04.357Z"
}
Timesheets
timesheet.created
Triggered when a new timesheet is created.
{
"data": {
"meta": {
"event_type": "timesheet.created",
"event_type_id": 15,
"organization_id": 112546,
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "xGt7b5_uCVenTFN_88IsU52ztxXg",
"user_id": 693316
},
"resource": {
"created": true,
"created_at": "2023-05-11T12:21:52.439Z",
"id": 10446275,
"public_id": "86ea6346-e5d3-491c-a065-1aa14cf7e3a6",
"status": "pending"
}
},
"timestamp": "2023-05-11T12:22:24.801Z"
}
timesheet.reviewed
Triggered when a timesheet is approved or denied.
{
"data": {
"meta": {
"event_type": "timesheet.reviewed",
"event_type_id": 17,
"organization_id": 112546,
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "2eOkiX_eF54esABbKcPZg5WfS7VR",
"user_id": 693316
},
"resource": [
{
"id": 10446275,
"public_id": "86ea6346-e5d3-491c-a065-1aa14cf7e3a6",
"status": "approved"
}
]
},
"timestamp": "2023-05-11T15:12:41.663Z"
}
Timeoff
time-off.created
Triggered when a new time off request is created.
{
"data": {
"meta": {
"event_type": "time-off.created",
"event_type_id": 13,
"organization_id": 112546,
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "lVwar8_G7sAYkvpUaQoiiEsu176W",
"user_id": 693331
},
"resource": {
"applied_changes": [],
"attachments": [],
"can_request_changes": true,
"change_request": null,
"contract_id": "EtNdZB0pxqli1FHXSg1fg",
"created_at": "2023-05-10T14:59:31.739Z",
"days_used_end_year": "0.00",
"days_used_start_year": "3.00",
"end_date": "2023-12-27T19:30:00.000Z",
"end_date_is_half_day": false,
"has_multiple_dates": true,
"id": 66984,
"is_updated": false,
"other_timeoff_name": null,
"reason": null,
"requested_at": "2023-05-10T14:59:31.737Z",
"requester": {
"id": 725396,
"is_employee": true,
"name": "John Snow",
"pic_url": null,
"profile_type": "contractor"
},
"reviewed_at": null,
"reviewer": null,
"start_date": "2023-12-24T19:30:00.000Z",
"start_date_is_half_day": false,
"status": "REQUESTED",
"total_days_used": "3.00",
"type": "VACATION",
"updated_at": "2023-05-10T14:59:31.739Z"
}
},
"timestamp": "2023-05-10T14:59:33.999Z"
}
time-off.reviewed
Triggered when a time off request is approved or denied.
{
"data": {
"meta": {
"event_type": "time-off.reviewed",
"event_type_id": 12,
"organization_id": "112546",
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "qzsx4Q_4mJe7rGWdrya__dOntUE9",
"user_id": 693316
},
"resource": {
"applied_changes": [],
"attachments": [],
"can_request_changes": true,
"change_request": null,
"contract_id": 699508,
"created_at": "2023-05-10T14:59:31.739Z",
"days_used_end_year": "0.00",
"days_used_start_year": "3.00",
"denial_reason": "Not this day",
"end_date": "2023-12-27T19:30:00.000Z",
"end_date_is_half_day": false,
"has_multiple_dates": true,
"id": 66984,
"is_updated": false,
"other_timeoff_name": null,
"reason": null,
"requested_at": "2023-05-10T14:59:31.737Z",
"requester": {
"id": 725396,
"is_employee": true,
"name": "John Snow",
"pic_url": null,
"profile_type": "contractor"
},
"reviewed_at": "2023-05-10T15:14:04.696Z",
"reviewer": {
"id": 725379,
"name": "John Doe",
"pic_url": null,
"profile_type": "client"
},
"start_date": "2023-12-24T19:30:00.000Z",
"start_date_is_half_day": false,
"status": "REJECTED",
"total_days_used": "3.00",
"type": "VACATION",
"updated_at": "2023-05-10T15:14:04.697Z"
}
},
"timestamp": "2023-05-10T15:14:07.326Z"
}
time-off.updated
Triggered when a time off request is updated.
{
"data": {
"meta": {
"event_type": "time-off.updated",
"event_type_id": 19,
"organization_id": 112546,
"organization_name": "Deel",
"serviceVersion": "0.4.4",
"tracking_id": "SemZYn_uDt3sMbMvfF-FKhAim-Nd",
"user_id": 693331
},
"resource": {
"applied_changes": {},
"attachments": {},
"can_request_changes": true,
"change_request": null,
"contract_id": "136336",
"created_at": "2023-05-11T15:21:49.237Z",
"days_used_end_year": "0.00",
"days_used_start_year": "1.00",
"end_date": "2029-01-01T19:30:00.000Z",
"end_date_is_half_day": false,
"has_multiple_dates": true,
"id": 68041,
"is_updated": false,
"other_timeoff_name": null,
"reason": null,
"requested_at": "2023-05-11T15:21:49.236Z",
"requester": {
"id": 725396,
"is_employee": true,
"name": "John Snow",
"pic_url": null,
"profile_type": "contractor"
},
"reviewed_at": null,
"reviewer": null,
"start_date": "2028-12-31T19:30:00.000Z",
"start_date_is_half_day": false,
"status": "REQUESTED",
"total_days_used": "1.00",
"type": "VACATION",
"updated_at": "2023-05-11T15:23:21.577Z"
}
},
"timestamp": "2023-05-11T15:23:23.675Z"
}
Updated 4 months ago