For AI agents: visit https://docs.oysterhr.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API Reference Changelog

API Reference

Guides API Reference Changelog

Authentication

Authentication
- Create or refresh an access tokenpost

Endpoints

Team Member Management
Finance
Company
Consent
- Revoke consent grantdel
- Create consent grantpost
Hiring & Onboarding
API Operations
- Retrieve an operationget
Offboarding
Payments
Payroll
Webhooks

Webhook Events

Benefits
Contract Changes
Engagements
Expenses
Hiring
Identity Verification
Invoicing
Offboarding
Operations
- async_operation_completedwebhook
Payments
Payroll
Time Off
Time Tracking

Powered by

hiring.oyster_invitation_accepted

webhook

hiring.oyster_invitation_accepted

Payload

A team member joined the Oyster platform

id

string

required

Globally unique identifier for this event

companyId

string

required

Unique identifier of the company the event was triggered for

eventTimestamp

date-time

required

Time the event occurred, in ISO 8601 format

eventName

const

enum

required

Name of the event

Allowed:

data

object

required

Event-specific context

Response

200

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

Updated about 2 months ago

hiring.employment_submitted

hiring.task_updated

Did this page help you?

Loading…

Updated about 2 months ago

hiring.employment_submitted

hiring.task_updated

Did this page help you?