Apideck CLI: Query 200+ SaaS APIs from your terminal. No SDK needed. Read more

Apideck Documentation Page

Webhook Events

Webhook Events endpoints for the HRIS API Unified API

10.24.32
Run In Postman
|Full reference

Employee Created
Webhook

Event broadcast when an employee has been created.

Header parameters

x-apideck-event-typestring
required
Enum:*hris.employee.createdhris.employee.updatedhris.employee.terminated

The type of event that was triggered

x-apideck-signaturestring
required

HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck

x-apideck-idempotency-keystring
required

A unique identifier for the webhook event, can be used to prevent duplicate processing

Request body schema

application/json
payloadobject

Responses

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

Mapping coverage per connector

ADP iHCM
ADP iHCM
virtual event
RUN Powered by ADP
RUN Powered by ADP
virtual event
ADP Workforce Now
ADP Workforce Now
virtual event
AFAS Software
AFAS Software
virtual event
Simployer One
Simployer One
virtual event
Microsoft Entra
Microsoft Entra
virtual event
BambooHR
BambooHR
virtual event
Breathe HR
Breathe HR
virtual event
IRIS Cascade HR
IRIS Cascade HR
virtual event
CatalystOne
CatalystOne
virtual event
Ceridian Dayforce
Ceridian Dayforce
virtual event
CharlieHR
CharlieHR
virtual event
Deel
Deel
virtual event
Employment Hero
Employment Hero
virtual event
Factorial
Factorial
native event
Folks HR
Folks HR
virtual event
Fourth
Fourth
virtual event
Google Workspace
Google Workspace
virtual event
G
Gusto
virtual event
Hibob
Hibob
virtual event
Holded
Holded
virtual event
Humaans
Humaans
virtual event
Justworks
Justworks
virtual event
Loket.nl
Loket.nl
virtual event
Lucca
Lucca
virtual event
Microsoft Dynamics 365 Human Resources
Microsoft Dynamics 365 Human Resources
virtual event
Namely
Namely
virtual event
Visma Nmbrs
Visma Nmbrs
virtual event
Officient
Officient
native event
Okta
Okta
native event
OneLogin
OneLogin
native event
Paychex
Paychex
virtual event
PayFit
PayFit
virtual event
Paylocity
Paylocity
virtual event
People HR
People HR
virtual event
Personio
Personio
virtual event
R
Rippling
native event
Sage HR
Sage HR
virtual event
SAP SuccessFactors
SAP SuccessFactors
virtual event
Sapling
Sapling
virtual event
SD Worx
SD Worx
virtual event
UKG Pro
UKG Pro
virtual event
Workday
Workday
virtual event
Zoho People
Zoho People
virtual event
Acerta
Acerta
Request
Cegid Talentsoft
Cegid Talentsoft
Request
Cezanne HR
Cezanne HR
Request
CIPHR
CIPHR
Request
Homerun HR
Homerun HR
Request
HR Works
HR Works
Request
JumpCloud
JumpCloud
Request
Keka HR
Keka HR
Request
Kenjo
Kenjo
Request
Liantis
Liantis
Request
Remote
Remote
Request
SD Worx (Web service)
SD Worx (Web service)
Request
Sesame HR
Sesame HR
Request
Sympa
Sympa
Request
TriNet
TriNet
Request

Example Event

Payload
{
  "payload": {
    "event_type": "hris.employee.created",
    "unified_api": "hris",
    "service_id": "bamboo",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/hris/employees/123456ASDF",
    "entity_type": "employee",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Employee Updated
Webhook

Event broadcast when an employee has been updated.

Header parameters

x-apideck-event-typestring
required
Enum:*hris.employee.createdhris.employee.updatedhris.employee.terminated

The type of event that was triggered

x-apideck-signaturestring
required

HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck

x-apideck-idempotency-keystring
required

A unique identifier for the webhook event, can be used to prevent duplicate processing

Request body schema

application/json
payloadobject

Responses

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

Mapping coverage per connector

ADP iHCM
ADP iHCM
virtual event
RUN Powered by ADP
RUN Powered by ADP
virtual event
ADP Workforce Now
ADP Workforce Now
virtual event
AFAS Software
AFAS Software
virtual event
Simployer One
Simployer One
virtual event
Microsoft Entra
Microsoft Entra
virtual event
BambooHR
BambooHR
virtual event
Breathe HR
Breathe HR
virtual event
IRIS Cascade HR
IRIS Cascade HR
virtual event
CatalystOne
CatalystOne
virtual event
CharlieHR
CharlieHR
virtual event
Deel
Deel
virtual event
Employment Hero
Employment Hero
virtual event
Factorial
Factorial
native event
Folks HR
Folks HR
virtual event
Fourth
Fourth
virtual event
Google Workspace
Google Workspace
virtual event
G
Gusto
virtual event
Hibob
Hibob
virtual event
Holded
Holded
virtual event
Humaans
Humaans
virtual event
Justworks
Justworks
virtual event
Loket.nl
Loket.nl
virtual event
Lucca
Lucca
virtual event
Microsoft Dynamics 365 Human Resources
Microsoft Dynamics 365 Human Resources
virtual event
Namely
Namely
virtual event
Visma Nmbrs
Visma Nmbrs
virtual event
Officient
Officient
native event
Okta
Okta
native event
OneLogin
OneLogin
native event
Paychex
Paychex
virtual event
PayFit
PayFit
virtual event
Paylocity
Paylocity
virtual event
People HR
People HR
virtual event
Personio
Personio
virtual event
R
Rippling
native event
Sage HR
Sage HR
virtual event
SAP SuccessFactors
SAP SuccessFactors
virtual event
Sapling
Sapling
virtual event
SD Worx
SD Worx
virtual event
UKG Pro
UKG Pro
virtual event
Workday
Workday
virtual event
Zoho People
Zoho People
virtual event
Acerta
Acerta
Request
Cegid Talentsoft
Cegid Talentsoft
Request
Ceridian Dayforce
Ceridian Dayforce
Request
Cezanne HR
Cezanne HR
Request
CIPHR
CIPHR
Request
Homerun HR
Homerun HR
Request
HR Works
HR Works
Request
JumpCloud
JumpCloud
Request
Keka HR
Keka HR
Request
Kenjo
Kenjo
Request
Liantis
Liantis
Request
Remote
Remote
Request
SD Worx (Web service)
SD Worx (Web service)
Request
Sesame HR
Sesame HR
Request
Sympa
Sympa
Request
TriNet
TriNet
Request

Example Event

Payload
{
  "payload": {
    "event_type": "hris.employee.updated",
    "unified_api": "hris",
    "service_id": "bamboo",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/hris/employees/123456ASDF",
    "entity_type": "employee",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Employee Terminated
Webhook

Event broadcast when an employee has been terminated.

Header parameters

x-apideck-event-typestring
required
Enum:*hris.employee.createdhris.employee.updatedhris.employee.terminated

The type of event that was triggered

x-apideck-signaturestring
required

HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck

x-apideck-idempotency-keystring
required

A unique identifier for the webhook event, can be used to prevent duplicate processing

Request body schema

application/json
payloadobject

Responses

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

Mapping coverage per connector

ADP Workforce Now
ADP Workforce Now
virtual event
AFAS Software
AFAS Software
virtual event
Simployer One
Simployer One
virtual event
BambooHR
BambooHR
virtual event
Breathe HR
Breathe HR
virtual event
IRIS Cascade HR
IRIS Cascade HR
virtual event
CatalystOne
CatalystOne
virtual event
Deel
Deel
virtual event
Employment Hero
Employment Hero
virtual event
Factorial
Factorial
native event
Folks HR
Folks HR
virtual event
G
Gusto
virtual event
Hibob
Hibob
virtual event
Humaans
Humaans
virtual event
Justworks
Justworks
virtual event
Lucca
Lucca
virtual event
Microsoft Dynamics 365 Human Resources
Microsoft Dynamics 365 Human Resources
virtual event
Namely
Namely
virtual event
Officient
Officient
native event
Okta
Okta
native event
PayFit
PayFit
virtual event
People HR
People HR
virtual event
Personio
Personio
virtual event
R
Rippling
native event
Sage HR
Sage HR
virtual event
SAP SuccessFactors
SAP SuccessFactors
virtual event
Sapling
Sapling
virtual event
SD Worx
SD Worx
virtual event
Workday
Workday
virtual event
Zoho People
Zoho People
virtual event
Acerta
Acerta
Request
ADP iHCM
ADP iHCM
Request
RUN Powered by ADP
RUN Powered by ADP
Request
Microsoft Entra
Microsoft Entra
Request
Cegid Talentsoft
Cegid Talentsoft
Request
Ceridian Dayforce
Ceridian Dayforce
Request
Cezanne HR
Cezanne HR
Request
CharlieHR
CharlieHR
Request
CIPHR
CIPHR
Request
Fourth
Fourth
Request
Google Workspace
Google Workspace
Request
Holded
Holded
Request
Homerun HR
Homerun HR
Request
HR Works
HR Works
Request
JumpCloud
JumpCloud
Request
Keka HR
Keka HR
Request
Kenjo
Kenjo
Request
Liantis
Liantis
Request
Loket.nl
Loket.nl
Request
Visma Nmbrs
Visma Nmbrs
Request
OneLogin
OneLogin
Request
Paychex
Paychex
Request
Paylocity
Paylocity
Request
Remote
Remote
Request
SD Worx (Web service)
SD Worx (Web service)
Request
Sesame HR
Sesame HR
Request
Sympa
Sympa
Request
TriNet
TriNet
Request
UKG Pro
UKG Pro
Request

Example Event

Payload
{
  "payload": {
    "event_type": "hris.employee.terminated",
    "unified_api": "hris",
    "service_id": "bamboo",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/hris/employees/123456ASDF",
    "entity_type": "employee",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Employee Deleted
Webhook

Event broadcast when an employee has been deleted.

Header parameters

x-apideck-event-typestring
required
Enum:*hris.employee.createdhris.employee.updatedhris.employee.terminated

The type of event that was triggered

x-apideck-signaturestring
required

HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck

x-apideck-idempotency-keystring
required

A unique identifier for the webhook event, can be used to prevent duplicate processing

Request body schema

application/json
payloadobject

Responses

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

Mapping coverage per connector

Okta
Okta
native event
OneLogin
OneLogin
native event
R
Rippling
native event
Acerta
Acerta
Request
ADP iHCM
ADP iHCM
Request
RUN Powered by ADP
RUN Powered by ADP
Request
ADP Workforce Now
ADP Workforce Now
Request
AFAS Software
AFAS Software
Request
Simployer One
Simployer One
Request
Microsoft Entra
Microsoft Entra
Request
BambooHR
BambooHR
Request
Breathe HR
Breathe HR
Request
IRIS Cascade HR
IRIS Cascade HR
Request
CatalystOne
CatalystOne
Request
Cegid Talentsoft
Cegid Talentsoft
Request
Ceridian Dayforce
Ceridian Dayforce
Request
Cezanne HR
Cezanne HR
Request
CharlieHR
CharlieHR
Request
CIPHR
CIPHR
Request
Deel
Deel
Request
Employment Hero
Employment Hero
Request
Factorial
Factorial
Request
Folks HR
Folks HR
Request
Fourth
Fourth
Request
Google Workspace
Google Workspace
Request
G
Gusto
Request
Hibob
Hibob
Request
Holded
Holded
Request
Homerun HR
Homerun HR
Request
HR Works
HR Works
Request
Humaans
Humaans
Request
JumpCloud
JumpCloud
Request
Justworks
Justworks
Request
Keka HR
Keka HR
Request
Kenjo
Kenjo
Request
Liantis
Liantis
Request
Loket.nl
Loket.nl
Request
Lucca
Lucca
Request
Microsoft Dynamics 365 Human Resources
Microsoft Dynamics 365 Human Resources
Request
Namely
Namely
Request
Visma Nmbrs
Visma Nmbrs
Request
Officient
Officient
Request
Paychex
Paychex
Request
PayFit
PayFit
Request
Paylocity
Paylocity
Request
People HR
People HR
Request
Personio
Personio
Request
Remote
Remote
Request
Sage HR
Sage HR
Request
SAP SuccessFactors
SAP SuccessFactors
Request
Sapling
Sapling
Request
SD Worx
SD Worx
Request
SD Worx (Web service)
SD Worx (Web service)
Request
Sesame HR
Sesame HR
Request
Sympa
Sympa
Request
TriNet
TriNet
Request
UKG Pro
UKG Pro
Request
Workday
Workday
Request
Zoho People
Zoho People
Request

Example Event

Payload
{
  "payload": {
    "event_type": "hris.employee.deleted",
    "unified_api": "hris",
    "service_id": "bamboo",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/hris/employees/123456ASDF",
    "entity_type": "employee",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Company Created
Webhook

Event broadcast when a company has been created.

Header parameters

x-apideck-event-typestring
required
Enum:*hris.employee.createdhris.employee.updatedhris.employee.terminated

The type of event that was triggered

x-apideck-signaturestring
required

HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck

x-apideck-idempotency-keystring
required

A unique identifier for the webhook event, can be used to prevent duplicate processing

Request body schema

application/json
payloadobject

Responses

200Return a 200 status to indicate that the data was received successfully.
Acerta
Acerta
Request
ADP iHCM
ADP iHCM
Request
RUN Powered by ADP
RUN Powered by ADP
Request
ADP Workforce Now
ADP Workforce Now
Request
AFAS Software
AFAS Software
Request
Simployer One
Simployer One
Request
Microsoft Entra
Microsoft Entra
Request
BambooHR
BambooHR
Request
Breathe HR
Breathe HR
Request
IRIS Cascade HR
IRIS Cascade HR
Request
CatalystOne
CatalystOne
Request
Cegid Talentsoft
Cegid Talentsoft
Request
Ceridian Dayforce
Ceridian Dayforce
Request
Cezanne HR
Cezanne HR
Request
CharlieHR
CharlieHR
Request
CIPHR
CIPHR
Request
Deel
Deel
Request
Employment Hero
Employment Hero
Request
Factorial
Factorial
Request
Folks HR
Folks HR
Request
Fourth
Fourth
Request
Google Workspace
Google Workspace
Request
G
Gusto
Request
Hibob
Hibob
Request
Holded
Holded
Request
Homerun HR
Homerun HR
Request
HR Works
HR Works
Request
Humaans
Humaans
Request
JumpCloud
JumpCloud
Request
Justworks
Justworks
Request
Keka HR
Keka HR
Request
Kenjo
Kenjo
Request
Liantis
Liantis
Request
Loket.nl
Loket.nl
Request
Lucca
Lucca
Request
Microsoft Dynamics 365 Human Resources
Microsoft Dynamics 365 Human Resources
Request
Namely
Namely
Request
Visma Nmbrs
Visma Nmbrs
Request
Officient
Officient
Request
Okta
Okta
Request
OneLogin
OneLogin
Request
Paychex
Paychex
Request
PayFit
PayFit
Request
Paylocity
Paylocity
Request
People HR
People HR
Request
Personio
Personio
Request
Remote
Remote
Request
R
Rippling
Request
Sage HR
Sage HR
Request
SAP SuccessFactors
SAP SuccessFactors
Request
Sapling
Sapling
Request
SD Worx
SD Worx
Request
SD Worx (Web service)
SD Worx (Web service)
Request
Sesame HR
Sesame HR
Request
Sympa
Sympa
Request
TriNet
TriNet
Request
UKG Pro
UKG Pro
Request
Workday
Workday
Request
Zoho People
Zoho People
Request

Example Event

Payload
{
  "payload": {
    "event_type": "hris.company.created",
    "unified_api": "hris",
    "service_id": "bamboo",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/hris/companies/123456ASDF",
    "entity_type": "company",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Company Updated
Webhook

Event broadcast when a company has been updated.

Header parameters

x-apideck-event-typestring
required
Enum:*hris.employee.createdhris.employee.updatedhris.employee.terminated

The type of event that was triggered

x-apideck-signaturestring
required

HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck

x-apideck-idempotency-keystring
required

A unique identifier for the webhook event, can be used to prevent duplicate processing

Request body schema

application/json
payloadobject

Responses

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

Mapping coverage per connector

R
Rippling
native event
Acerta
Acerta
Request
ADP iHCM
ADP iHCM
Request
RUN Powered by ADP
RUN Powered by ADP
Request
ADP Workforce Now
ADP Workforce Now
Request
AFAS Software
AFAS Software
Request
Simployer One
Simployer One
Request
Microsoft Entra
Microsoft Entra
Request
BambooHR
BambooHR
Request
Breathe HR
Breathe HR
Request
IRIS Cascade HR
IRIS Cascade HR
Request
CatalystOne
CatalystOne
Request
Cegid Talentsoft
Cegid Talentsoft
Request
Ceridian Dayforce
Ceridian Dayforce
Request
Cezanne HR
Cezanne HR
Request
CharlieHR
CharlieHR
Request
CIPHR
CIPHR
Request
Deel
Deel
Request
Employment Hero
Employment Hero
Request
Factorial
Factorial
Request
Folks HR
Folks HR
Request
Fourth
Fourth
Request
Google Workspace
Google Workspace
Request
G
Gusto
Request
Hibob
Hibob
Request
Holded
Holded
Request
Homerun HR
Homerun HR
Request
HR Works
HR Works
Request
Humaans
Humaans
Request
JumpCloud
JumpCloud
Request
Justworks
Justworks
Request
Keka HR
Keka HR
Request
Kenjo
Kenjo
Request
Liantis
Liantis
Request
Loket.nl
Loket.nl
Request
Lucca
Lucca
Request
Microsoft Dynamics 365 Human Resources
Microsoft Dynamics 365 Human Resources
Request
Namely
Namely
Request
Visma Nmbrs
Visma Nmbrs
Request
Officient
Officient
Request
Okta
Okta
Request
OneLogin
OneLogin
Request
Paychex
Paychex
Request
PayFit
PayFit
Request
Paylocity
Paylocity
Request
People HR
People HR
Request
Personio
Personio
Request
Remote
Remote
Request
Sage HR
Sage HR
Request
SAP SuccessFactors
SAP SuccessFactors
Request
Sapling
Sapling
Request
SD Worx
SD Worx
Request
SD Worx (Web service)
SD Worx (Web service)
Request
Sesame HR
Sesame HR
Request
Sympa
Sympa
Request
TriNet
TriNet
Request
UKG Pro
UKG Pro
Request
Workday
Workday
Request
Zoho People
Zoho People
Request

Example Event

Payload
{
  "payload": {
    "event_type": "hris.company.updated",
    "unified_api": "hris",
    "service_id": "bamboo",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/hris/companies/123456ASDF",
    "entity_type": "company",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}

Company Deleted
Webhook

Event broadcast when a company has been deleted.

Header parameters

x-apideck-event-typestring
required
Enum:*hris.employee.createdhris.employee.updatedhris.employee.terminated

The type of event that was triggered

x-apideck-signaturestring
required

HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck

x-apideck-idempotency-keystring
required

A unique identifier for the webhook event, can be used to prevent duplicate processing

Request body schema

application/json
payloadobject

Responses

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

Mapping coverage per connector

R
Rippling
native event
Acerta
Acerta
Request
ADP iHCM
ADP iHCM
Request
RUN Powered by ADP
RUN Powered by ADP
Request
ADP Workforce Now
ADP Workforce Now
Request
AFAS Software
AFAS Software
Request
Simployer One
Simployer One
Request
Microsoft Entra
Microsoft Entra
Request
BambooHR
BambooHR
Request
Breathe HR
Breathe HR
Request
IRIS Cascade HR
IRIS Cascade HR
Request
CatalystOne
CatalystOne
Request
Cegid Talentsoft
Cegid Talentsoft
Request
Ceridian Dayforce
Ceridian Dayforce
Request
Cezanne HR
Cezanne HR
Request
CharlieHR
CharlieHR
Request
CIPHR
CIPHR
Request
Deel
Deel
Request
Employment Hero
Employment Hero
Request
Factorial
Factorial
Request
Folks HR
Folks HR
Request
Fourth
Fourth
Request
Google Workspace
Google Workspace
Request
G
Gusto
Request
Hibob
Hibob
Request
Holded
Holded
Request
Homerun HR
Homerun HR
Request
HR Works
HR Works
Request
Humaans
Humaans
Request
JumpCloud
JumpCloud
Request
Justworks
Justworks
Request
Keka HR
Keka HR
Request
Kenjo
Kenjo
Request
Liantis
Liantis
Request
Loket.nl
Loket.nl
Request
Lucca
Lucca
Request
Microsoft Dynamics 365 Human Resources
Microsoft Dynamics 365 Human Resources
Request
Namely
Namely
Request
Visma Nmbrs
Visma Nmbrs
Request
Officient
Officient
Request
Okta
Okta
Request
OneLogin
OneLogin
Request
Paychex
Paychex
Request
PayFit
PayFit
Request
Paylocity
Paylocity
Request
People HR
People HR
Request
Personio
Personio
Request
Remote
Remote
Request
Sage HR
Sage HR
Request
SAP SuccessFactors
SAP SuccessFactors
Request
Sapling
Sapling
Request
SD Worx
SD Worx
Request
SD Worx (Web service)
SD Worx (Web service)
Request
Sesame HR
Sesame HR
Request
Sympa
Sympa
Request
TriNet
TriNet
Request
UKG Pro
UKG Pro
Request
Workday
Workday
Request
Zoho People
Zoho People
Request

Example Event

Payload
{
  "payload": {
    "event_type": "hris.company.deleted",
    "unified_api": "hris",
    "service_id": "bamboo",
    "consumer_id": "test_user_id",
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entity_id": "123456ASDF",
    "entity_url": "https://unify.apideck.com/hris/companies/123456ASDF",
    "entity_type": "company",
    "occurred_at": "2020-01-01T00:00:00.000Z"
  }
}