For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
Get SupportGet a demo
  • Get Started
    • Welcome
    • Quickstart
  • Webhooks
    • Introduction
    • Creating a Webhook
    • Available Webhooks
  • Public API Reference (Beta)
    • Applicants/Candidates
    • Jobs
    • Contacts/Managers
    • Clients/Departments
    • Universal Search
    • Lookup
    • Custom Fields
        • POSTActivity Webhook Payload
        • POSTApplicant Webhook Payload
        • POSTContact Webhook Payload
        • POSTEmployee Webhook Payload
        • POSTJob Webhook Payload
        • POSTNote Webhook Payload
        • POSTPlacement Webhook Payload
        • POSTSubmittal Activity Webhook Payload
        • POSTTimesheet Webhook Payload
  • Internal API Reference
    • Applicants/Candidates
    • Clients/Departments
    • Contacts/Managers
  • Welcome
  • Quickstart
  • Introduction
  • Creating a Webhook
  • Available Webhooks
  • Public API Reference (Beta)
  • Applicants/Candidates
  • Create an applicant
  • Delete an applicant
  • Get an applicant
  • List applicants
  • Update an applicant
  • Add a note to an applicant
  • Add a phone number to an applicant
  • Add an education history entry to an applicant
  • Add an employment history entry to an applicant
  • Assign a tag to an applicant
  • List an applicant's education history
  • List an applicant's employment history
  • List an applicant's notes
  • List an applicant's phone numbers
  • List an applicant's resumes
  • List an applicant's tags
  • Remove a note from an applicant
  • Remove a phone number from an applicant
  • Remove a resume from an applicant
  • Remove a social link from an applicant
  • Remove a tag from an applicant
  • Remove an education history entry from an applicant
  • Remove an employment history entry from an applicant
  • Set a social link on an applicant
  • Upload a resume for an applicant
  • List searchable applicant fields
  • Search applicants
  • Jobs
  • Create a Job
  • Delete a Job
  • Get a Job
  • List Jobs
  • Update a Job
  • Assign a job category to a Job
  • Assign a job function to a Job
  • Assign a job industry to a Job
  • Assign a recruiter to a Job
  • Assign a sourcer to a Job
  • Assign a vendor to a Job
  • Assign a workgroup to a Job
  • Remove a job category from a Job
  • Remove a job function from a Job
  • Remove a job industry from a Job
  • Remove a recruiter from a Job
  • Remove a sourcer from a Job
  • Remove a vendor from a Job
  • Remove a workgroup from a Job
  • List Searchable Job Fields
  • Search Jobs
  • Contacts/Managers
  • Create a contact
  • Delete a contact
  • Get a contact
  • List contacts
  • Update a contact
  • Assign a job approver to a contact
  • List a contact's job approvers
  • Remove a job approver from a contact
  • Add a note to a contact
  • Add a phone number to a contact
  • Assign a tag to a contact
  • List a contact's notes
  • List a contact's phone numbers
  • List a contact's tags
  • Remove a note from a contact
  • Remove a phone number from a contact
  • Remove a tag from a contact
  • List searchable contact fields
  • Search contacts
  • Create a client office
  • Delete a client office
  • Get a client office
  • List client offices
  • Update a client office
  • Add a note to a client office
  • Add a phone number to a client office
  • List a client office's notes
  • List a client office's phone numbers
  • Remove a note from a client office
  • Remove a phone number from a client office
  • Clients/Departments
  • Create a client
  • Delete a client
  • Get a client
  • List clients
  • Update a client
  • Add a note to a client
  • Assign a tag to a client
  • List a client's attachments
  • List a client's notes
  • List a client's tags
  • Remove a note from a client
  • Remove a tag from a client
  • Remove an attachment from a client
  • Upload an attachment for a client
  • Create an opportunity
  • Delete an opportunity
  • Get an opportunity
  • List opportunities
  • Update an opportunity
  • Assign a contact to an opportunity
  • Assign a sales representative to an opportunity
  • Remove a contact from an opportunity
  • Remove a sales representative from an opportunity
  • Add a line item to an opportunity
  • List an opportunity's activities
  • List an opportunity's attachments
  • List an opportunity's line items
  • Remove a line item from an opportunity
  • Remove an attachment from an opportunity
  • Upload an attachment for an opportunity
  • Create a placement
  • Delete a placement
  • Get a placement
  • List placements
  • Update a placement
  • Get a placement's product
  • List a placement's invoice lines
  • Create a submittal
  • Delete a submittal
  • Get a submittal
  • List submittals
  • Update a submittal
  • Create a submittal activity
  • Delete a submittal activity
  • Get a submittal activity
  • List submittal activities
  • Update a submittal activity
  • Universal Search
  • List universal search fields
  • Universal search
  • Lookup
  • List Job categories
  • List Job functions
  • List Job groups
  • List Job industries
  • List workgroups
  • List applicant sources
  • List applicant statuses
  • List disability statuses
  • List education types
  • List employment types
  • List existing applicant tags
  • List genders
  • List phone types
  • List race/ethnicity values
  • List veteran statuses
  • List visa/work permit statuses
  • List contact phone types
  • List contact statuses
  • List sales account types
  • List territories
  • List lead sources
  • List opportunity next steps
  • List opportunity stages
  • List opportunity types
  • List submittal statuses
  • List submittal activity types
  • List back-office payment terms
  • List pay/rate types
  • List placement types
  • List states
  • Custom Fields
  • Clear a custom field's value for an entity
  • Get custom field values for an entity
  • List custom field definitions
  • Set a custom field's value for an entity
  • Activity Webhook Payload
  • Applicant Webhook Payload
  • Contact Webhook Payload
  • Employee Webhook Payload
  • Job Webhook Payload
  • Note Webhook Payload
  • Placement Webhook Payload
  • Submittal Activity Webhook Payload
  • Timesheet Webhook Payload
  • Internal API Reference
  • Applicants/Candidates
  • Check for Duplicate Applicants
  • Copy and Import an Applicant
  • Copy and Import an Applicant
  • Delete an Applicant
  • Get a Lightweight Applicant
  • Get a list of Applicants
  • Get an Applicant
  • Get Applicant Rate Card
  • Persist an Applicant
  • Add Resume with File
  • Delete an Applicant Resume
  • Get All Applicant Resumes
  • Get Latest Resume
  • Get Word Map for a resume
  • Parse Resume Text
  • Save an Applicant Resume
  • Update Duplicate
  • Upload a Resume File
  • Delete Applicant Phone
  • Get Applicant Phone
  • Persist Applicant Phone
  • Delete Applicant Note
  • Get Applicant Note
  • Persist Applicant Note
  • Create an Applicant Attachment
  • Delete Applicant Attachment
  • Download an Applicant BQ Attachment
  • Get an Applicant Attachment
  • Get an Applicant BQ Attachment
  • Get Applicant Attachment
  • Get Applicant Attachments
  • Get Applicant Attachments
  • Get Applicant Attachments
  • Get Applicant Public Attachments List
  • Update Applicant Attachment
  • Delete Applicant Reference
  • Get Applicant References
  • Persist Applicant Reference
  • Delete An Applicant Employment History Record
  • Get An Applicant Employment History Record
  • Parse Applicant Employment History
  • Persist An Applicant Employment History Record
  • Set Record as Current Employment
  • Delete Applicant Education
  • Get Applicant Education
  • Parse Applicant Education History
  • Persist Applicant Education
  • Get All Applicant Exam Results
  • Get An Applicant Exam Result
  • Assign An Applicant Exam
  • Unassign An Applicant Exam
  • Get Assigned Applicant Folders
  • Get Available Applicant Folders
  • Assign Applicant Folder
  • Unassign Applicant Folder
  • Make an Applicant into a Contact
  • Make an Applicant into a Contact
  • Delete Requirement
  • Find Public Requirements By Query
  • Find Requirement
  • Find Requirement By Id
  • Find Requirements By Query
  • Get Rate Card
  • Persist a Requirement
  • Delete Requirement Note
  • Get Requirement Note
  • Persist Requirement Note
  • Delete Requirement Attachment
  • Find Requirement Attachments
  • Get Requirement Attachment
  • Insert Requirement Attachment
  • Update Requirement Attachment
  • Assign Requirement To Folder
  • Get Assigned Requirement Folders
  • Get Available Requirement Folders
  • Remove Requirement From Folder
  • Delete Requirement Template
  • Find Requirement Template
  • Get Requirement Template
  • Get Requirement Templates
  • Persist Requirement Template
  • Clients/Departments
  • Delete Client
  • Get Client
  • Save a Client
  • Get a Clients Phones
  • Delete a Client Note
  • Get a Client Note
  • Persist a Client Note
  • Add a Client Attachment
  • Delete a Client Attachment
  • Get a Client Attachment
  • List Client Attachments
  • Update Client Attachment
  • Assign Client To Folder
  • Get Clients Assigned Folders
  • Get Clients Available Folders
  • Unassign Client From Folder
  • Contacts/Managers
  • List Contacts by Search
  • List Contacts For Client
  • Get Contact
  • Save a Contact
  • Delete a Contact
  • Get Contact Note
  • Persist Contact Note
  • Delete Contact Note
  • List Contact Attachments
  • Download Contact Attachment
  • Create a Contact Attachment
  • Update Contact Attachment
  • Delete Contact Attachment
  • Get Assigned Contact Folders
  • Assign Contact Folder
  • Unassign Contact Folder
  • Delete an Office
  • Get an Office
  • List Offices by Client
  • Save an Office
  • Delete Office Note
  • Get Office Note
  • Save Office Note
  • Delete Office Phone
  • Get Office Phone
  • Persist Office Phone
  • Get a list of User Activities
  • Get a User Activity
  • Persist an Activity
  • Persist a Calendar Activity
  • Delete a User Activity
  • Get a Submittal Activity by its GUID
  • Persist a Submittal Activity
  • Delete a Submittal Activity by its GUID
  • Find Submittal Activities
  • Find Submittal
  • Create Submittal
  • Create Submittals per Applicant
  • Delete Submittal
  • Find Placement
  • Get a Placement
  • Persist Placement
  • Get Submittal Status
  • Evaluate Submittal
  • Evaluate Job
  • Get Company
  • Get Contact
  • Get Job Posting
  • Get Company
  • Verify Website TLD
  • List Office Employees
  • Get Company Office
  • Save Company Office
  • Delete Company Office
  • List Company Phones
  • Save Office Phone
  • Delete Office Phone
  • List Company Employees and Executives
  • List Company Employees
  • Get Company Employee
  • Save Company Employee
  • Delete Company Employee
  • List Application Questions
  • Post Application
  • List All Folders By Type
  • List My Folders By Type
  • List Public Folders By Type
  • Get a Folder by Type
  • Entity Type
  • List Countries
  • List States
  • List States By Country
  • List Locales
  • List Applicant Status List
  • List Applicant Phone Types
  • List Applicant Sources
  • List Disability Status Types
  • List Education Types
  • List Gender Types
  • List Race Types
  • List Veteran Status Types
  • List Work Permits
  • List Social Link Types
  • List Employment Types
  • List Contact Phone Types
  • List Contact Statuses
  • List Sales Account Types
  • List Territories
  • List Workgroups
  • List Recruiters Lite
  • List Recruiters
  • List Submittal Status
  • List Phone Types
  • List Pay Types
  • List Salutations
  • List RPO Templates
  • Get Person
  • Delete User Phone
  • Save User Phone
Get SupportGet a demo
Public API Reference (Beta)WebhooksPayloads

Activity Webhook Payload

Payload
1{}
Was this page helpful?
Previous

Applicant Webhook Payload

Next
Built with

Payload

The payload of this webhook request is an object.
idlongOptional
guidstringOptional
startDatedatetimeOptional
endDatedatetimeOptional
reminderDatedatetimeOptional
typeobjectOptional
commentstringOptional
activityUserobjectOptional
entityTypeenumOptional
allDaybooleanOptional
completedbooleanOptional
completedDatedatetimeOptional
createUserobjectOptional
modifyUserobjectOptional
createDatedatetimeOptional
modifyDatedatetimeOptional
attendeeslist of objectsOptional
extApplicationenumOptional
extApplicationKeystringOptional

Response

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