Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
event

Return individual event, including payload

get/v1/org/{orgId}/event/{eventId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

eventIdstring required

Response

successful operation

idstring required

globally unique id

userIdstring required

user id who caused the event

orgIdstring

parent organization id

type'APP' | 'APPROVE' | 'CANCEL' | 'COMBINE' | 'CREATE' | 'DELETE' | 'DONE' | 'ERROR' | 'EXPORT' | 'EXPORT_CSV' | 'EXPORT_ORG_CHART' | 'GENERATE' | 'GEOIP' | 'INCOMING' | 'INSTALL' | 'INVITE' | 'INBOUND' | 'LOGIN' | 'MERGE' | 'MESSAGE' | 'OUTBOUND' | 'PREVIEW_AS' | 'READ' | 'READ_EXTERNAL' | 'READ_SENSITIVE' | 'READ_ATS' | 'READ_ATS_WEBHOOK' | 'READ_FULL_NAME' | 'READ_FUTURE_DATE' | 'READ_METADATA' | 'READ_COMP' | 'READ_BILLING' | 'READ_PENDING' | 'READ_PAYROLL' | 'READ_SENSITIVE_FILTERS' | 'WRITE_EXTERNAL' | 'REASSIGN' | 'REJECT' | 'RELEASE' | 'REMIND' | 'REMOVE_PASSWORD' | 'REQUEST' | 'RESTORE' | 'RESUME' | 'REVOKE' | 'RUN' | 'RUN_ATS' | 'SECURITY' | 'SHARE' | 'SHOW_DASHBOARD_DAYS_AHEAD' | 'SHOW_OPEN_JOBS' | 'STEP' | 'SUBMIT' | 'SYNC' | 'TEST' | 'TOKEN' | 'UNINSTALL' | 'UPDATE' | 'UPDATE_PASSWORD' | 'UPLOAD_CSV' | 'WRITE' | 'VIEW_AS' required

type of event

entityType'ACTION' | 'AGREEMENT' | 'AI_AGENT' | 'AI_AGENT_MEMORY' | 'AI_CHAT' | 'AI_CONFIG' | 'AI_CREDIT_LIMIT' | 'AI_CREDIT_USAGE' | 'AI_HINT' | 'AI_PROMPT' | 'APP' | 'APP_CONFIG' | 'APPROVAL_CHAIN' | 'APPROVAL_CHAIN_STAGE' | 'APPROVAL_DELEGATE' | 'APPROVAL_REQUEST' | 'ASSESSMENT' | 'BUDGET' | 'BUDGET_POOL' | 'BUNDLE' | 'CALENDAR' | 'CALENDAR_ENTRY' | 'CATEGORY' | 'CATEGORY_SORT' | 'CHANGE' | 'COMMENT' | 'COMP_BAND' | 'COMP_REVIEW' | 'CONTENT' | 'CUSTOMER' | 'DATA_VIEW' | 'EXCHANGE_RATE' | 'EMAIL_TEMPLATE' | 'EVENT' | 'FIELD' | 'FILE' | 'FORM' | 'FORM_DRAFT' | 'FORM_RESPONSE' | 'GEOCODE' | 'GROUP' | 'GROUP_ALLOCATION' | 'GROUP_TYPE' | 'GOAL' | 'GOAL_PROGRESS' | 'GOAL_TARGET' | 'GOAL_TYPE' | 'GUIDELINE' | 'JOB' | 'JOB_CODE' | 'JOB_LEVEL' | 'MEDIA' | 'MESSAGE' | 'MULTIPLIER' | 'ORG' | 'ORG_CONFIG' | 'PERSON' | 'PROFILE_TAB' | 'POLICY' | 'PROCESS' | 'PRODUCT' | 'QUERY_TOKEN' | 'QUESTION' | 'REPORT' | 'REPORT_CHART' | 'ROLE' | 'SCENARIO' | 'SIGNATURE' | 'SIGNATURE_REQUEST' | 'STOCK_GRANT' | 'STOCK_PRICE' | 'TABLE' | 'TABLE_ROW' | 'TASK_CONFIG' | 'TEMPLATE' | 'TASK' | 'TOKEN' | 'TIMEOFF' | 'TIMEOFF_BALANCE_ADJUSTMENT' | 'TIMEOFF_LEDGER_ENTRY' | 'TIMEOFF_POLICY' | 'TRANSCRIPT' | 'USER' required

type of target entity

entityIdstring required

id of target entity

behalfUserIdstring

id of the original user this app user is acting on behalf of

agentUserIdstring

id of the agent (app user) if this event was performed by an agent on behalf of a user

aiChatIdstring

id of the AI chat that this event derives from

aiToolUseIdstring

AI chat tool use identifier that ties this event to a specific tool invocation

jobIdstring

jobId of the entity, if the entity is a job or closely connected to a single job

personIdstring

personId of the entity, if the entity is a person or closely connected to a single person

tableIdstring

id of table, if entity is a table row

subtypestring

subtype of entity

payloadobject

event-specific payload containing information about the change that took place

atstring required

timestamp of event

processIdstring

id of process

datestring date

effective date, if in use

scenarioIdstring

id of scenario

parentEntityIdstring

id of associated entity, such as comp cycle

fieldsstring[]

set of fields that were updated by the event

codestring

event code, for example job.update

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "userId": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "entityId": "588f7ee98f138b19220041a7",
  "behalfUserId": "588f7ee98f138b19220041a7",
  "agentUserId": "588f7ee98f138b19220041a7",
  "aiChatId": "588f7ee98f138b19220041a7",
  "jobId": "588f7ee98f138b19220041a7",
  "personId": "588f7ee98f138b19220041a7",
  "tableId": "588f7ee98f138b19220041a7",
  "processId": "588f7ee98f138b19220041a7",
  "scenarioId": "588f7ee98f138b19220041a7",
  "parentEntityId": "588f7ee98f138b19220041a7"
}