Applicant Webhook Payload | BrightMove Technical Documentation

1 { 2 "id": 0, 3 "guid": "guid", 4 "statusId": 0, 5 "firstName": "firstName", 6 "middleName": "middleName", 7 "lastName": "lastName", 8 "email": "email", 9 "workEmail": "workEmail", 10 "type": "-1", 11 "phones": [ 12 { 13 "type": "type", 14 "phoneNumber": "phoneNumber" 15 } 16 ], 17 "emailAllowed": false, 18 "smsAllowed": false, 19 "location": { 20 "address1": "address1", 21 "address2": "address2", 22 "city": "city", 23 "state": { 24 "id": 0, 25 "name": "name", 26 "abbrev": "abbrev", 27 "country": { 28 "id": 0, 29 "code": "code", 30 "name": "name" 31 } 32 }, 33 "postalCode": "postalCode" 34 }, 35 "primarySkills": "primarySkills", 36 "status": "status", 37 "source": "source", 38 "currentCompany": "currentCompany", 39 "currentTitle": "currentTitle", 40 "currentPay": { 41 "rate": 0, 42 "type": "type" 43 }, 44 "desiredPay": { 45 "rate": 0, 46 "type": "type" 47 }, 48 "displayName": "displayName" 49 }

Payload

The payload of this webhook request is an object.

idlongOptional

guidstringOptional

statusIdintegerOptional

firstNamestringOptional

middleNamestringOptional

lastNamestringOptional

emailstringOptional

workEmailstringOptional

typeenumOptional

phoneslist of objectsOptional

emailAllowedbooleanOptional

smsAllowedbooleanOptional

locationobjectOptional

primarySkillsstringOptional

statusstringOptional

sourcestringOptional

currentCompanystringOptional

currentTitlestringOptional

currentPayobjectOptional

desiredPayobjectOptional

displayNamestringOptional

Response

200

any

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