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
    • 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
  • Welcome
  • Quickstart
  • Introduction
  • Creating a Webhook
  • Available Webhooks
  • Public API Reference
  • 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
Get SupportGet a demo
Public API ReferenceWebhooksPayloads

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.