Automation Data Payloads
This article outlines Automation data payloads accessible via from the EdsEntityType, EdsEntityTypeSchemaVersion, and EdsSourceSystem tables. You can import Automation data, both internally and externally, through . This allows you to use the data to customize your reporting and meet any specific requirements you have.
The following are examples of use cases:
- Measuring communication metrics, such as OptOuts in the last 30 days
- Identifying new candidates in the last seven days without engagement
- Evaluating performance across customers based on Net Promoter Score (NPS)
- Determining at-risk candidates, such as pending starters with no calls within the last 30 days
To have this feature enabled submit a ticket to Support.
Requirements
Data Hub is not supported for Bullhorn Recruitment Cloud clients. As a result, automation data payloads aren't available.
You require the following to use Automation data payloads:
- Bullhorn Automation Enterprise
- Data Replication 8 or Bullhorn Analytics Enterprise
Data Structure
To see an example of how payloads are structured, see Automation Data Payload Example.
To see an example of how to create views, see Automation Data View Example.
Data Payloads
receives automation data in structured JSON payloads. Each payload contains one entity, and the structure varies by data type.
-
Data is delivered as a single JSON entity field per payload.
-
Each data type has its own structure.
-
Use source IDs to link records to Bullhorn entities.
- If you're new to JSON, use this Microsoft article for an introduction.
- Note: This is a third-party resource provided for convenience. Bullhorn does not endorse or manage its content.
Each payload comprises the following sections:
| Section | Definition |
|---|---|
| Events | Communication metric events, including OptOut, Bounce, Open, Click, Send, JobView, JobApply, PageView, TextResponse, TextSendAutomated, TextBounce, TextOptOut, TextSendManual, and TextClick. |
| AutomationAssignments | A list of automation assignments, including Candidate, SalesContact, Placement, Submission, Company, Job, User, Note, Opportunity, and Lead assignments. |
| Surveys | Engagement information (Survey or Chatbot), which includes information like the survey name, date created, and settings. |
| SurveyQuestions | Includes survey question information, like question type, answer options, etc. |
| SurveyAnswers | Includes candidates' answers to questions. |
| SurveySubmittals | High-level submittals where the candidate completed a survey on specific date and tied the submittal to the survey. |
| SurveyAnswerSubmittals | A child entity of the survey submittal which shows the response for each question. To get to the survey, you would need to first join to the submittal. |
| SurveyNpsAnswerSubmittals | Includes a list of questions and answers for determining NPS. |
Data Fields
The following table outlines each payload's fields and data points:
| Name | Data Points |
|---|---|
| Events |
Customer_ID ID Type Url PageTitle Description EmailTemplate_Id TextMessageTemplate_ID BullhornCandidateID BullhornLeadID BullhornJobID DateCreated DateModified |
| Automation Assignments |
Customer_ID ID Automation_ID AutomationName EntityID EntityType DateEnded Status BullhornCandidateID BullhornSalesContactID BullhornPlacementID BullhornSubmissionID |
| Surveys |
Name CustomerPageUrl AddResponsesToNote NoteAction SendNotification SendNotificationToOwner NotificationEmails IntroText SubmitLabel CompletionMessage SendSurvResponsesasCsvEmails IsDeleted Type |
| Survey Questions |
QuestionText Type Scale DisplayOption MinScaleText MaxScaleText Order IsRequired IntValue IsDeleted Survey_ID SurveyBranchContainer SurveyBranch_ID Customer_ID ID DateCreated DateModified |
| Survey Answers |
AnswerText Order IsDeleted Question_ID SurveyBranch_ID ID DateCreated DateModified |
| Survey Submittals |
Completed AllQuestionsAnswered AddedNotification Candidate_ID EntityID UnknownVisitorID Survey_ID BullhornCandidateID BullhornSalesContactID BullhornPlacementID BullhornSubmissionID Customer_ID ID DateCreated DateModified |
| Survey Answer Submittals |
StringValue DateValue IntValue Candidate_ID EntityID Answer_ID SurveySubmittal_ID BullhornCandidateID BullhornSalesContactID BullhornPlacementID BullhornSubmissionID Customer_ID ID DateCreated DateModified |
| Survey NPS Answer Submittals |
SurveyName QuestionText Scale IntValue Candidate_ID EntityID Answer_ID SurveySubmittal_ID BullhornCandidateID BullhornSalesContactID BullhornPlacementID BullhornSubmissionID Customer_ID ID DateCreated DateModified |