Job Webhook Payload

Payload

1 {
2   "id": 0,
3   "guid": "guid",
4   "externalId": "externalId",
5   "jobTitle": "jobTitle",
6   "openDate": "openDate",
7   "endDate": "endDate",
8   "duration": "duration",
9   "location": {
10     "address1": "address1",
11     "address2": "address2",
12     "city": "city",
13     "state": {
14       "id": 0,
15       "name": "name",
16       "abbrev": "abbrev",
17       "country": {
18         "id": 0,
19         "code": "code",
20         "name": "name"
21       }
22     },
23     "postalCode": "postalCode"
24   },
25   "requiredSkills": "requiredSkills",
26   "optionalSkills": "optionalSkills",
27   "publicDescription": "publicDescription",
28   "privateDescription": "privateDescription",
29   "jobStatus": "jobStatus",
30   "minBillRate": {
31     "rate": 0,
32     "type": "type"
33   },
34   "maxBillRate": {
35     "rate": 0,
36     "type": "type"
37   },
38   "minPayRate": {
39     "rate": 0,
40     "type": "type"
41   },
42   "maxPayRate": {
43     "rate": 0,
44     "type": "type"
45   },
46   "bonusPct": 0,
47   "bonusFlat": 0,
48   "bonusNotes": "bonusNotes",
49   "openings": 0,
50   "originalOpenings": 0,
51   "createDate": "createDate",
52   "createUser": {
53     "id": 0,
54     "guid": "guid",
55     "statusId": 0,
56     "firstName": "firstName",
57     "middleName": "middleName",
58     "lastName": "lastName",
59     "email": "email",
60     "workEmail": "workEmail",
61     "type": "-1",
62     "phones": [
63       {
64         "type": "type",
65         "phoneNumber": "phoneNumber"
66       }
67     ],
68     "displayName": "displayName"
69   },
70   "modifyDate": "modifyDate",
71   "modifyUser": {
72     "id": 0,
73     "guid": "guid",
74     "statusId": 0,
75     "firstName": "firstName",
76     "middleName": "middleName",
77     "lastName": "lastName",
78     "email": "email",
79     "workEmail": "workEmail",
80     "type": "-1",
81     "phones": [
82       {
83         "type": "type",
84         "phoneNumber": "phoneNumber"
85       }
86     ],
87     "displayName": "displayName"
88   },
89   "placementType": "placementType",
90   "jobGroup": {
91     "id": 0,
92     "name": "name"
93   },
94   "statusComment": "statusComment",
95   "categories": [
96     "categories"
97   ],
98   "industries": [
99     "industries"
100   ],
101   "functions": [
102     "functions"
103   ],
104   "feePct": 0,
105   "feeAmt": 0,
106   "pctChanceClose": 0,
107   "postToInternal": false,
108   "postToWeb": false,
109   "syncDescription": false,
110   "workFromHome": false,
111   "partTime": false,
112   "recruiter": {
113     "id": 0,
114     "guid": "guid",
115     "statusId": 0,
116     "firstName": "firstName",
117     "middleName": "middleName",
118     "lastName": "lastName",
119     "email": "email",
120     "workEmail": "workEmail",
121     "type": "-1",
122     "phones": [
123       {
124         "type": "type",
125         "phoneNumber": "phoneNumber"
126       }
127     ],
128     "officeName": "officeName",
129     "mobilePhone": "mobilePhone",
130     "companyGk": 0,
131     "displayName": "displayName"
132   },
133   "assignedRecruiters": [
134     {
135       "id": 0,
136       "guid": "guid",
137       "statusId": 0,
138       "firstName": "firstName",
139       "middleName": "middleName",
140       "lastName": "lastName",
141       "email": "email",
142       "workEmail": "workEmail",
143       "type": "-1",
144       "phones": [
145         {
146           "type": "type",
147           "phoneNumber": "phoneNumber"
148         }
149       ],
150       "officeName": "officeName",
151       "mobilePhone": "mobilePhone",
152       "companyGk": 0,
153       "displayName": "displayName"
154     }
155   ],
156   "contact": {
157     "id": 0,
158     "guid": "guid",
159     "statusId": 0,
160     "firstName": "firstName",
161     "middleName": "middleName",
162     "lastName": "lastName",
163     "email": "email",
164     "workEmail": "workEmail",
165     "type": "-1",
166     "phones": [
167       {
168         "type": "type",
169         "phoneNumber": "phoneNumber"
170       }
171     ],
172     "title": "title",
173     "location": {
174       "address1": "address1",
175       "address2": "address2",
176       "city": "city",
177       "state": {
178         "id": 0,
179         "name": "name",
180         "abbrev": "abbrev",
181         "country": {
182           "id": 0,
183           "code": "code",
184           "name": "name"
185         }
186       },
187       "postalCode": "postalCode"
188     },
189     "nickname": "nickname",
190     "client": {
191       "id": 0,
192       "guid": "guid",
193       "name": "name",
194       "website": "website",
195       "billingLocation": {
196         "address1": "address1",
197         "address2": "address2",
198         "city": "city",
199         "state": {
200           "id": 0,
201           "name": "name",
202           "abbrev": "abbrev",
203           "country": {
204             "id": 0,
205             "code": "code",
206             "name": "name"
207           }
208         },
209         "postalCode": "postalCode"
210       },
211       "discountPercentage": 0,
212       "discountFee": 0,
213       "stockSymbol": "stockSymbol",
214       "companyInfo": "companyInfo",
215       "createDate": "createDate",
216       "modifyDate": "modifyDate",
217       "createUser": {
218         "id": 0,
219         "guid": "guid",
220         "statusId": 0,
221         "firstName": "firstName",
222         "middleName": "middleName",
223         "lastName": "lastName",
224         "email": "email",
225         "workEmail": "workEmail",
226         "type": "-1",
227         "phones": [
228           {
229             "type": "type",
230             "phoneNumber": "phoneNumber"
231           }
232         ],
233         "displayName": "displayName"
234       },
235       "modifyUser": {
236         "id": 0,
237         "guid": "guid",
238         "statusId": 0,
239         "firstName": "firstName",
240         "middleName": "middleName",
241         "lastName": "lastName",
242         "email": "email",
243         "workEmail": "workEmail",
244         "type": "-1",
245         "phones": [
246           {
247             "type": "type",
248             "phoneNumber": "phoneNumber"
249           }
250         ],
251         "displayName": "displayName"
252       },
253       "legacyId": "legacyId"
254     },
255     "office": {
256       "id": 0,
257       "guid": "guid",
258       "name": "name",
259       "location": {
260         "address1": "address1",
261         "address2": "address2",
262         "city": "city",
263         "state": {
264           "id": 0,
265           "name": "name",
266           "abbrev": "abbrev",
267           "country": {
268             "id": 0,
269             "code": "code",
270             "name": "name"
271           }
272         },
273         "postalCode": "postalCode"
274       }
275     },
276     "emailAllowed": false,
277     "smsAllowed": false,
278     "contactStatus": "contactStatus",
279     "displayName": "displayName"
280   },
281   "metaData": {}
282 }

Payload

The payload of this webhook request is an object.

idlongOptional

guidstringOptional

externalIdstringOptional

jobTitlestringOptional

openDatedatetimeOptional

endDatedatetimeOptional

durationstringOptional

locationobjectOptional

requiredSkillsstringOptional

optionalSkillsstringOptional

publicDescriptionstringOptional

privateDescriptionstringOptional

jobStatusstringOptional

minBillRateobjectOptional

maxBillRateobjectOptional

minPayRateobjectOptional

maxPayRateobjectOptional

bonusPctdoubleOptional

bonusFlatdoubleOptional

bonusNotesstringOptional

openingsintegerOptional

originalOpeningsintegerOptional

createDatedatetimeOptional

createUserobjectOptional

modifyDatedatetimeOptional

modifyUserobjectOptional

placementTypestringOptional

jobGroupobjectOptional

statusCommentstringOptional

categorieslist of stringsOptional

industrieslist of stringsOptional

functionslist of stringsOptional

feePctdoubleOptional

feeAmtdoubleOptional

pctChanceClosedoubleOptional

postToInternalbooleanOptional

postToWebbooleanOptional

syncDescriptionbooleanOptional

workFromHomebooleanOptional

partTimebooleanOptional

recruiterobjectOptional

assignedRecruiterslist of objectsOptional

contactobjectOptional

metaDatamap from strings to stringsOptional

Response

200

any

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