Kota Types of events API
The Types of events API from Kota — 0 operation(s) for types of events.
The Types of events API from Kota — 0 operation(s) for types of events.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/kota-types-of-events-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Kota Types of events API
version: '1.0'
servers:
- url: https://test.api.kota.io
description: Test Kota API
x-fern-server-name: test
- url: https://api.kota.io
description: Production Kota API
x-fern-server-name: production
security:
- bearerAuth: []
tags:
- name: Types of events
paths: {}
webhooks:
EmployeeCreatedWebhook:
post:
tags:
- Types of events
summary: employee.created
operationId: EmployeeCreatedWebhook
requestBody:
description: An employee was created
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeCreatedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployeeUpdatedWebhook:
post:
tags:
- Types of events
summary: employee.updated
operationId: EmployeeUpdatedWebhook
requestBody:
description: An employee was updated
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeUpdatedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployeeOffboardedWebhook:
post:
tags:
- Types of events
summary: employee.offboarded
operationId: EmployeeOffboardedWebhook
requestBody:
description: An employee was offboarded
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeOffboardedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployerCreatedWebhook:
post:
tags:
- Types of events
summary: employer.created
operationId: EmployerCreatedWebhook
requestBody:
description: An employer was created
content:
application/json:
schema:
$ref: '#/components/schemas/EmployerCreatedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployerUpdatedWebhook:
post:
tags:
- Types of events
summary: employer.updated
operationId: EmployerUpdatedWebhook
requestBody:
description: An employer was updated
content:
application/json:
schema:
$ref: '#/components/schemas/EmployerUpdatedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployerOffboardedWebhook:
post:
tags:
- Types of events
summary: employer.offboarded
operationId: EmployerOffboardedWebhook
requestBody:
description: An employer was offboarded
content:
application/json:
schema:
$ref: '#/components/schemas/EmployerOffboardedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployerHealthInsuranceQuoteCreatedWebhook:
post:
tags:
- Types of events
summary: employer.health_insurance.quote.created
operationId: EmployerHealthInsuranceQuoteCreatedWebhook
requestBody:
description: A group health insurance quote request was created for an employer
content:
application/json:
schema:
$ref: '#/components/schemas/EmployerHealthInsuranceQuoteCreatedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployerHealthInsuranceQuoteActionRequiredWebhook:
post:
tags:
- Types of events
summary: employer.health_insurance.quote.action_required
operationId: EmployerHealthInsuranceQuoteActionRequiredWebhook
requestBody:
description: A group health insurance quote requires an action from the employer
content:
application/json:
schema:
$ref: '#/components/schemas/EmployerHealthInsuranceQuoteActionRequiredWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployerHealthInsuranceQuoteNotUndertakenWebhook:
post:
tags:
- Types of events
summary: employer.health_insurance.quote.not_undertaken
operationId: EmployerHealthInsuranceQuoteNotUndertakenWebhook
requestBody:
description: A group health insurance quote was not taken out
content:
application/json:
schema:
$ref: '#/components/schemas/EmployerHealthInsuranceQuoteNotUndertakenWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployerHealthInsuranceQuoteAcceptedWebhook:
post:
tags:
- Types of events
summary: employer.health_insurance.quote.accepted
operationId: EmployerHealthInsuranceQuoteAcceptedWebhook
requestBody:
description: A group health insurance quote was accepted
content:
application/json:
schema:
$ref: '#/components/schemas/EmployerHealthInsuranceQuoteAcceptedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployerHealthInsuranceQuotePendingWebhook:
post:
tags:
- Types of events
summary: employer.health_insurance.quote.pending_quote
operationId: EmployerHealthInsuranceQuotePendingWebhook
requestBody:
description: A group health insurance request for quote was made
content:
application/json:
schema:
$ref: '#/components/schemas/EmployerHealthInsuranceQuotePendingWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook:
post:
tags:
- Types of events
summary: employer.health_insurance.quote.pending_insurer_acceptance
operationId: EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook
requestBody:
description: A group health insurance quote is now pending acceptance by the insurer
content:
application/json:
schema:
$ref: '#/components/schemas/EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployeeHealthInsuranceOfferActionRequiredWebhook:
post:
tags:
- Types of events
summary: employee.health_insurance.offer.action_required
operationId: EmployeeHealthInsuranceOfferActionRequiredWebhook
requestBody:
description: A health insurance offer requires action from an employee.
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeHealthInsuranceOfferActionRequiredWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployeeHealthInsurancePolicyActivatedWebhook:
post:
tags:
- Types of events
summary: employee.health_insurance.policy.activated
operationId: EmployeeHealthInsurancePolicyActivatedWebhook
requestBody:
description: An Employee health insurance policy is successfully activated.
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeHealthInsurancePolicyActivatedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployeeHealthInsurancePolicyCancelledWebhook:
post:
tags:
- Types of events
summary: employee.health_insurance.policy.cancelled
operationId: EmployeeHealthInsurancePolicyCancelledWebhook
requestBody:
description: An Employee health insurance policy is successfully cancelled.
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeHealthInsurancePolicyCancelledWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
EmployeeHealthInsurancePolicyExpiredWebhook:
post:
tags:
- Types of events
summary: employee.health_insurance.policy.expired
operationId: EmployeeHealthInsurancePolicyExpiredWebhook
requestBody:
description: An Employee health insurance policy is expired.
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeHealthInsurancePolicyExpiredWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
ContributionReportFinalizedWebhook:
post:
tags:
- Types of events
summary: contribution_report.finalized
operationId: ContributionReportFinalizedWebhook
requestBody:
description: A contribution report has been finalized
content:
application/json:
schema:
$ref: '#/components/schemas/ContributionReportFinalizedWebhook'
responses:
2xx:
description: Your server implementation should return this HTTP status code if the data was received successfully
4xx:
description: If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5xx:
description: If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!
x-fern-webhook: true
components:
schemas:
ContactModel:
required:
- email
- name
type: object
properties:
name:
type: string
description: 'Contact person name. NOTE: This field will be normalized according to our internal formatting rules.'
email:
type: string
description: 'Contact email address. NOTE: This field will be normalized according to our internal formatting rules.'
additionalProperties: false
HealthInsuranceCoverageLevelResponse:
required:
- documents
- plan_currency
- plan_id
- plan_name
- provider_logo_url
- provider_name
type: object
properties:
plan_id:
pattern: pl_.+
type: string
description: Unique identifier for the health insurance plan
example: pl_3b1333d87d9d4fd6ad83ba7f6b0e951a
plan_name:
type: string
description: Name of the health insurance plan
plan_currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Currency code of the health insurance plan
provider_name:
type: string
description: Name of the health insurance provider
provider_logo_url:
type: string
description: Logo URL of the health insurance provider
provider_employer_platform_url:
type:
- 'null'
- string
description: URL to the health insurance provider's website for Employer Management
provider_support_phone:
type:
- 'null'
- string
description: Support phone number to the health insurance provider's website for Employer Management
documents:
type: array
items:
$ref: '#/components/schemas/HealthInsuranceCoverageLevelDocumentResponse'
description: Documents related to the health insurance plan, these documents may change at renewal, this includes the documents like `Insurance Product Information Document`, `Hospital Lists`, `Table of Cover` etc
additionalProperties: false
EmployerStatus:
enum:
- pending
- active
- offboarding
- inactive
- restricted
type: string
AddressModel:
required:
- city
- country_code
- line1
- postal_code
type: object
properties:
line1:
type: string
description: 'Must not be empty. NOTE: This field will be normalized according to our internal formatting rules.'
line2:
type:
- 'null'
- string
description: 'NOTE: This field will be normalized according to our internal formatting rules.'
line3:
type:
- 'null'
- string
description: 'NOTE: This field will be normalized according to our internal formatting rules.'
city:
type: string
description: 'Must not be empty. NOTE: This field will be normalized according to our internal formatting rules.'
state:
type:
- 'null'
- string
description: 'Required for United States (State), and Canada (Province). NOTE: This field will be normalized according to our internal formatting rules.'
postal_code:
type: string
description: 'Must not be empty, and a valid postal code for the specified country. NOTE: This field will be normalized according to our internal formatting rules.'
country_code:
allOf:
- $ref: '#/components/schemas/CountryCode'
additionalProperties: false
ContributionReportFinalizedWebhook:
title: ContributionReportFinalizedWebhook
required:
- id
- type
- platform_id
- data
- created_at
- object
- api_version
type: object
properties:
id:
pattern: evt_*
type: string
example: evt_3b1333d87d9d4fd6ad83ba7f6b0e951a
type:
type: string
example: contribution_report.finalized
platform_id:
pattern: pt_*
type: string
example: pt_3b1333d87d9d4fd6ad83ba7f6b0e951a
data:
$ref: '#/components/schemas/ContributionReportResponse'
created_at:
type: string
format: date-time
example: '2024-12-01T00:00:00Z'
object:
type: string
example: event
api_version:
type: string
example: '1.0'
EmployerHealthInsuranceQuoteNotUndertakenWebhook:
title: EmployerHealthInsuranceQuoteNotUndertakenWebhook
required:
- id
- type
- platform_id
- data
- created_at
- object
- api_version
type: object
properties:
id:
pattern: evt_*
type: string
example: evt_3b1333d87d9d4fd6ad83ba7f6b0e951a
type:
type: string
example: employer.health_insurance.quote.not_undertaken
platform_id:
pattern: pt_*
type: string
example: pt_3b1333d87d9d4fd6ad83ba7f6b0e951a
data:
$ref: '#/components/schemas/EmployerHealthInsuranceQuoteResponse'
created_at:
type: string
format: date-time
example: '2024-12-01T00:00:00Z'
object:
type: string
example: event
api_version:
type: string
example: '1.0'
HealthInsuranceRequiredActionResponse:
required:
- code
- due_at
- reason
- reason_description
type: object
properties:
reason:
type: string
description: Concise reason for the required action
reason_description:
type: string
description: Description for the required action
code:
type: string
description: Identified the type of action required, not unique across health insurance providers
due_at:
type: string
description: Date and time by which the action is due, if this is not completed then the policy will not be issued.
format: date
example: '2024-12-01'
additionalProperties: false
EmployerHealthInsuranceQuoteActionRequiredWebhook:
title: EmployerHealthInsuranceQuoteActionRequiredWebhook
required:
- id
- type
- platform_id
- data
- created_at
- object
- api_version
type: object
properties:
id:
pattern: evt_*
type: string
example: evt_3b1333d87d9d4fd6ad83ba7f6b0e951a
type:
type: string
example: employer.health_insurance.quote.action_required
platform_id:
pattern: pt_*
type: string
example: pt_3b1333d87d9d4fd6ad83ba7f6b0e951a
data:
$ref: '#/components/schemas/EmployerHealthInsuranceQuoteResponse'
created_at:
type: string
format: date-time
example: '2024-12-01T00:00:00Z'
object:
type: string
example: event
api_version:
type: string
example: '1.0'
EmployeeStatus:
enum:
- pending
- active
- offboarding
- inactive
- restricted
type: string
EmployeeHealthInsuranceOfferStatus:
enum:
- action_required
- not_undertaken
- accepted
type: string
EmployeeHealthInsurancePolicyCancelledWebhook:
title: EmployeeHealthInsurancePolicyCancelledWebhook
required:
- id
- type
- platform_id
- data
- created_at
- object
- api_version
type: object
properties:
id:
pattern: evt_*
type: string
example: evt_3b1333d87d9d4fd6ad83ba7f6b0e951a
type:
type: string
example: employee.health_insurance.policy.cancelled
platform_id:
pattern: pt_*
type: string
example: pt_3b1333d87d9d4fd6ad83ba7f6b0e951a
data:
$ref: '#/components/schemas/EmployeeHealthInsurancePolicyResponse'
created_at:
type: string
format: date-time
example: '2024-12-01T00:00:00Z'
object:
type: string
example: event
api_version:
type: string
example: '1.0'
HealthInsuranceCoverageLevelDocumentResponse:
required:
- link
- title
type: object
properties:
title:
type: string
description: Health Insurance Document Title
link:
type: string
description: Health Insurance Document Link (can be a link to a website or a file path)
additionalProperties: false
EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook:
title: EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook
required:
- id
- type
- platform_id
- data
- created_at
- object
- api_version
type: object
properties:
id:
pattern: evt_*
type: string
example: evt_3b1333d87d9d4fd6ad83ba7f6b0e951a
type:
type: string
example: employer.health_insurance.quote.pending_insurer_acceptance
platform_id:
pattern: pt_*
type: string
example: pt_3b1333d87d9d4fd6ad83ba7f6b0e951a
data:
$ref: '#/components/schemas/EmployerHealthInsuranceQuoteResponse'
created_at:
type: string
format: date-time
example: '2024-12-01T00:00:00Z'
object:
type: string
example: event
api_version:
type: string
example: '1.0'
EmployeeResponse:
required:
- date_of_birth
- email
- first_name
- last_name
- national_tax_id
- phone_number
- sex_at_birth
type: object
properties:
platform_id:
pattern: pt_.+
type: string
description: Unique identifier for the platform
example: pt_3b1333d87d9d4fd6ad83ba7f6b0e951a
id:
pattern: ee_.+
type: string
description: Unique identifier for the employee
example: ee_3b1333d87d9d4fd6ad83ba7f6b0e951a
employer_id:
pattern: er_.+
type: string
description: Unique identifier for the employer
example: er_3b1333d87d9d4fd6ad83ba7f6b0e951a
status:
allOf:
- $ref: '#/components/schemas/EmployeeStatus'
description: Current status of the employee
external_customer_id:
type:
- 'null'
- string
description: A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms.
first_name:
type: string
description: First name of the employee. It can include the middle name
last_name:
type: string
description: Last name of the employee
date_of_birth:
type: string
description: Date of birth of the employee
format: date
example: '2024-12-01'
sex_at_birth:
allOf:
- $ref: '#/components/schemas/SexAtBirth'
description: The sex assigned to the employee at birth
home_address:
type: 'null'
allOf:
- $ref: '#/components/schemas/AddressModel'
description: Location where the employee is legally registered to live
nationality:
type: 'null'
allOf:
- $ref: '#/components/schemas/CountryCode'
description: Nationality of the employee (e.g. IE for Ireland, GB for United Kingdom, ES for Spain)
national_tax_id:
type: string
description: PPSN in Ireland, NINo in the UK, DNI/NIE in Spain
start_on:
type: string
description: Employment start date
format: date
example: '2024-12-01'
earliest_benefits_start_date:
type:
- 'null'
- string
description: 'The earliest date this employee can be enrolled in any benefits. Before this date, the employee remains in a Pending state and is excluded from benefit activation. Ignored for statutory schemes where immediate coverage is legally required. Example: Local Netherlands and UAE schemes.'
format: date
example: '2024-12-01'
phone_number:
type: string
description: Phone number in E.164 international format (e.g. +447700900999)
email:
type: string
description: Email address of the employee
offboard_on:
type:
- 'null'
- string
description: Date when the employee was or will be offboarded
format: date-time
example: '2024-12-01T00:00:00Z'
bank_account:
type: 'null'
allOf:
- $ref: '#/components/schemas/EmployeeBankAccount'
description: Bank account details
metadata:
type:
- 'null'
- object
additionalProperties:
type: string
description: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters.
object:
type: string
description: The object type
readOnly: true
additionalProperties: false
HealthInsuranceGrossEstimationAmountResponse:
required:
- employee_contribution
- employer_contribution
- total
type: object
properties:
employee_contribution:
type: number
description: Estimated gross premium amount deducted from employee payroll
format: double
example: 123.45
employer_contribution:
type: number
description: Estimated gross premium amount paid by the employer
format: double
example: 123.45
total:
type: number
description: Total gross premium amount (sum of employee and employer contributions).
format: double
example: 123.45
additionalProperties: false
EmployerResponse:
required:
- contact
- id
- legal_address
- legal_name
type: object
properties:
id:
pattern: er_.+
type: string
example: er_3b1333d87d9d4fd6ad83ba7f6b0e951a
platform_id:
pattern: pt_.+
type: string
e
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kota/refs/heads/main/openapi/kota-types-of-events-api-openapi.yml