Automation Data Payload Example

Overview

The following is an example of a data payload in Bullhorn Automation and its structure.

For more info about data payloads, see Bullhorn Data Replication Automation Data Payloads.

Events

Data Hub Record

Copy
{
    "id":15220,
    "entityTypeId":1,
    "entityTypeSchemaVersionId":0,
    "dateAddedInSourceSystem":"2023-02-27T16:42:11.27",
    "dateLastModifiedInSourceSystem":null,
    "payload": BELOW,
    "isDeleted":false,
    "candidateId":99999,
    "clientContactId":null,
    "clientCorporationId":null,
    "jobOrderId":null,
    "jobSubmissionId":null,
    "placementId":null,
    "leadId":null,
    "opportunityId":null,
    "corporateUserId":null,
    "noteId":null,
    "appointmentId":null,
    "payableChargeId":null,
    "billableChargeId":null
}

Payload

Copy
{
    "Customer_Id":1,
    "Id":15220,
    "Type":”Send”,
    "Url":null,
    "PageTitle":null,
    "Description":null,
    "EmailTemplate_Id":17483,
    "TextMessageTemplate_Id":null,
    "BullhornCandidateId":99999,
    "BullhornLeadId":null,
    "BullhornJobId":null,
    "DateCreated":"2023-02-27T16:42:11.27",
    "DateModified":null
}

Enums

Copy
EventType
{
    OptOut,
    Bounce,
    Open,
    Click,
    Send,
    JobView,
    JobApply,
    PageView,
    TextResponse,
    TextSendAutomated,
    TextBounce,
    TextOptOut,
    TextSendManual,
    TextClick
}

AutomationAssignments

Data Hub Record

Copy
{
    "id":60184,
    "entityTypeId":2,
    "entityTypeSchemaVersionId":0,
    "dateAddedInSourceSystem":"2023-02-25T19:11:33.257",
    "dateLastModifiedInSourceSystem":"2023-02-27T16:31:38.63",
    "payload": BELOW,
    "isDeleted":false,
    "candidateId":1591,
    "clientContactId":null,
    "clientCorporationId":null,
    "jobOrderId":null,
    "jobSubmissionId":null,
    "placementId":null,
    "leadId":null,
    "opportunityId":null,
    "corporateUserId":null,
    "noteId":null,
    "appointmentId":null,
    "payableChargeId":null,
    "billableChargeId":null
}

Payload

Copy
{
    "Customer_Id":1,
    "Id":60184,
    "Automation_Id":19373,
    "AutomationName":"Send email",
    "EntityId":1610,
    "EntityType":”Candidate”,
    "DateEnded":null,
    "Status":”InProgress”,
    "BullhornCandidateId":1591,
    "BullhornSalesContactId":null,
    "BullhornPlacementId":null,
    "BullhornSubmissionId":null,
    "BullhornJobId":null,
    "DateCreated":"2023-02-25T19:11:33.257",
    "DateModified":"2023-02-27T16:31:38.63"
}

Enums

Copy
EntityType
{
    Candidate,
    SalesContact,
    Placement,
    Submission,
    Company,
    Job,
    User,
    Note,
    Opportunity,
    Lead
}

​​AssignmentStatus
{
    InProgress,
    Completed,
    Removed,
    Paused
}

Surveys

Data Hub Record

Copy
{
    "id":13,
    "entityTypeId":3,
    "entityTypeSchemaVersionId":0,
    "dateAddedInSourceSystem":"2018-10-30T15:12:45.75",
    "dateLastModifiedInSourceSystem":"2023-03-03T16:11:43.763",
    "payload":BELOW,
    "isDeleted":false,
    "candidateId":null,
    "clientContactId":null,
    "clientCorporationId":null,
    "jobOrderId":null,
    "jobSubmissionId":null,
    "placementId":null,
    "leadId":null,
    "opportunityId":null,
    "corporateUserId":null,
    "noteId":null,
    "appointmentId":null,
    "payableChargeId":null,
    "billableChargeId":null
}

Payload

Copy
{
    "Name":"NPS Survey - Sales Contacts",
    "CustomerPageUrl":"http://localhost:41118/Surveys/ClientPage",
    "AddResponsesToNote":false,
    "NoteAction":"Hubspot",
    "SendNotification":false,
    "SendNotificationToOwner":false,
    "NotificationEmails":"",
    "IntroText":"Hi %FIRSTNAME%, can you fill out these questions?",
    "SubmitLabel":"Submit",
    "CompletionMessage":"Thanks %FIRSTNAME%, we appreciate it",
    "SendSurveResponsesAsCsvEmails":null,
    "IsDeleted":false,
    "Type":”Survey”,
    "EntityType":”SalesContact”,
    "ContactType":”SalesContact”,
    "NotificationMessage":"<p style=\"margin: 0; padding: 0;\">%FIRSTNAME% has taken the survey %SURVEY_NAME%.</p><p style=\"margin: 0; padding: 0;\"><br></p><p style=\"margin: 0; padding: 0;\">%SURVEY_ANSWERS%</p>",
    "IsUnknownVisitorChat":false,
    "Customer_Id":1,
    "Id":13,
    "DateCreated":"2018-10-30T15:12:45.75",
    "DateModified":"2023-03-03T16:11:43.763"
}

Enums

Copy
SurveyType
{
    Survey,
    Chat
}

EntityType
{
    Candidate,
    SalesContact,
    Placement,
    Submission,
    Company,
    Job,
    User,
    Note,
    Opportunity,
    Lead
}

ContactType
{
    Candidate,
    SalesContact,
    None
}

SurveyQuestions

Data Hub Record

Copy
{
    "id":25,
    "entityTypeId":4,
    "entityTypeSchemaVersionId":0,
    "dateAddedInSourceSystem":"2018-10-30T15:12:45.75",
    "dateLastModifiedInSourceSystem":"2023-03-03T16:27:08.92",
    "payload": BELOW,
    "isDeleted":false,
    "candidateId":null,
    "clientContactId":null,
    "clientCorporationId":null,
    "jobOrderId":null,
    "jobSubmissionId":null,
    "placementId":null,
    "leadId":null,
    "opportunityId":null,
    "corporateUserId":null,
    "noteId":null,
    "appointmentId":null,
    "payableChargeId":null,
    "billableChargeId":null
}

Payload

Copy
{
    "QuestionText":"Do you have any questions for your recruiter?",
    "Type":”Choice”,
    "Scale":”OneToFive”,
    "DisplayOption":”Radio”,
    "MinScaleText":"Very Unlikely",
    "MaxScaleText":"Very Likely",
    "Order":2,
    "IsRequired":true,
    "IntValue":0,
    "IsDeleted":false,
    "Survey_Id":13,
    "SurveyBranchContainer_Id":null,
    "SurveyBranch_Id":null,
    "Customer_Id":1,
    "Id":25,
    "DateCreated":"2018-10-30T15:12:45.75",
    "DateModified":"2023-03-03T16:27:08.92"
}

Enums

Copy
SurveyQuestionType
{
    Text,
    Choice,
    NPS,
    Date,
    Statement,
    UploadResume,
    Rating,
    MultipleChoice,
    SingleLineInteger,
    Branch,
    JumpToEnd,
    JumpToSurvey,
    SendTextMessage,
    DisplayJobs
}

SurveyQuestionScale
{
    OneToFive,
    ZeroToTen
}

SurveyQuestionDisplayOption
{
    None,
    Button,
    Dropdown,
    Radio,
    Checkbox
}

SurveyAnswers

Data Hub Record

Copy
{
    "id":59,
    "entityTypeId":5,
    "entityTypeSchemaVersionId":0,
    "dateAddedInSourceSystem":"2018-10-30T15:12:45.75",
    "dateLastModifiedInSourceSystem":"2023-03-03T16:27:08.913",
    "payload": BELOW,
    "isDeleted":false,
    "candidateId":null,
    "clientContactId":null,
    "clientCorporationId":null,
    "jobOrderId":null,
    "jobSubmissionId":null,
    "placementId":null,
    "leadId":null,
    "opportunityId":null,
    "corporateUserId":null,
    "noteId":null,
    "appointmentId":null,
    "payableChargeId":null,
    "billableChargeId":null
}

Payload

Copy
{
    "AnswerText":"Yes",
    "Order":0,
    "IsDeleted":false,
    "Question_Id":25,
    "SurveyBranch_Id":null,
    "Customer_Id":1,
    "Id":59,
    "DateCreated":"2018-10-30T15:12:45.75",
    "DateModified":"2023-03-03T16:27:08.913"
}

Enums

None

SurveySubmittals

Data Hub Record

Copy
{
    "id":10188,
    "entityTypeId":6,
    "entityTypeSchemaVersionId":0,
    "dateAddedInSourceSystem":"2023-03-03T16:44:09.71",
    "dateLastModifiedInSourceSystem":"2023-03-03T16:44:12.767",
    "payload": BELOW,
    "isDeleted":false,
    "candidateId":null,
    "clientContactId":51137,
    "clientCorporationId":null,
    "jobOrderId":null,
    "jobSubmissionId":null,
    "placementId":null,
    "leadId":null,
    "opportunityId":null,
    "corporateUserId":null,
    "noteId":null,
    "appointmentId":null,
    "payableChargeId":null,
    "billableChargeId":null
}

Payload

Copy
{
    "Completed":false,
    "AllQuestionsAnswered":false,
    "AddedNotification":false,
    "Candidate_Id":58952,
    "EntityId":58952,
    "UnknownVisitorId":null,
    "Survey_Id":13,
    "BullhornCandidateId":null,
    "BullhornSalesContactId":51137,
    "BullhornPlacementId":null,
    "BullhornSubmissionId":null,
    "Customer_Id":1,
    "Id":10188,
    "DateCreated":"2023-03-03T16:44:09.71",
    "DateModified":"2023-03-03T16:44:12.767"
}

Enums

None

SurveyAnswerSubmittals

Data Hub Record

Copy
{
    "id":10804,
    "entityTypeId":7,
    "entityTypeSchemaVersionId":0,
    "dateAddedInSourceSystem":"2023-03-03T16:44:12.767",
    "dateLastModifiedInSourceSystem":null,
    "payload": BELOW,
    "isDeleted":false,
    "candidateId":null,
    "clientContactId":51137,
    "clientCorporationId":null,
    "jobOrderId":null,
    "jobSubmissionId":null,
    "placementId":null,
    "leadId":null,
    "opportunityId":null,
    "corporateUserId":null,
    "noteId":null,
    "appointmentId":null,
    "payableChargeId":null,
    "billableChargeId":null
}

Payload

Copy
{
    "StringValue":"No",
    "DateValue":null,
    "IntValue":null,
    "Candidate_Id":58952,
    "EntityId":58952,
    "Answer_Id":60,
    "SurveySubmittal_Id":10188,
    "BullhornCandidateId":null,
    "BullhornSalesContactId":51137,
    "BullhornPlacementId":null,
    "BullhornSubmissionId":null,
    "Customer_Id":1,
    "Id":10804,
    "DateCreated":"2023-03-03T16:44:12.767",
    "DateModified":null
}

Enums

None

SurveyNpsAnswerSubmittals

Data Hub Record

Copy
{
    "id":10803,
    "entityTypeId":8,
    "entityTypeSchemaVersionId":0,
    "dateAddedInSourceSystem":"2023-03-03T16:44:09.727",
    "dateLastModifiedInSourceSystem":null,
    "payload": BELOW,
    "isDeleted":false,
    "candidateId":null,
    "clientContactId":51137,
    "clientCorporationId":null,
    "jobOrderId":null,
    "jobSubmissionId":null,
    "placementId":null,
    "leadId":null,
    "opportunityId":null,
    "corporateUserId":null,
    "noteId":null,
    "appointmentId":null,
    "payableChargeId":null,
    "billableChargeId":null
}

Payload

Copy
{
    "SurveyName":"NPS Survey - Sales Contacts",
    "QuestionText":"How likely are you to refer a friend or colleague to Nemo Staffing?",
    "Scale":”OneToFive”,
    "IntValue":8,
    "Candidate_Id":58952,
    "EntityId":58952,
    "Answer_Id":64,
    "SurveySubmittal_Id":10188,
    "BullhornCandidateId":null,
    "BullhornSalesContactId":51137,
    "BullhornPlacementId":null,
    "BullhornSubmissionId":null,
    "Customer_Id":1,
    "Id":10803,
    "DateCreated":"2023-03-03T16:44:09.727",
    "DateModified":null
}

Enums

Copy
SurveyQuestionScale
{
    OneToFive,
    ZeroToTen
}