Skip to content

Commit c1e3394

Browse files
authored
Merge pull request #41 from VStatev/webhooks_auth
Webhooks auth
2 parents 3022623 + c88e344 commit c1e3394

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

source/includes/_webhooks.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ If the request to your configured URL returns with a status of `4XX` or `5XX` we
5353
are going to retry the delivery for 24 hours which exponential increasing intervals between the retries.
5454

5555
## Security Considerations
56-
As our webhooks don't provide authentication mechanisms, you shouldn't take the values contained in the requests as granted. It is considered a good practice to request the contained values by their reference id (e.g. job_application.received contains the job application id which allows you to request the referenced job application via our REST API)
57-
56+
You may optionally secure your webhooks endpoints using Basic Authentication or an OAuth 2.0 client credentials flow. Nevertheless, it is good practice to request the contained values by their reference id (e.g. job_application.received contains the job application id which allows you to request the referenced job application via our REST API).
5857
You can restrict the webhooks to only accept them from our IPs: 52.57.76.133, 52.57.83.207.
5958

6059
## Available Events
@@ -66,21 +65,15 @@ You can restrict the webhooks to only accept them from our IPs: 52.57.76.133, 52
6665
"job_application": {
6766
"id": "00000000-0000-0000-0000-000000000000",
6867
"job_id": "00000000-0000-0000-0000-000000000000",
69-
"rating": "A, B or C",
7068
"created_by_user_id": "00000000-0000-0000-0000-000000000000",
71-
"status": "IN_PROGRESS, HIRED or CLOSED",
72-
"applicant_image": "http://example.com/applicant_image.png",
73-
"attachments": [
74-
"https://api.1brd.com/v1/companies/00000000-0000-0000-0000-000000000000/applications/d648096f-c3f4-4121-af9a-5377753e467e/files/a3beb15a-84ac-4646-a20b-7aa5faf982a7"
75-
]
69+
"status": "PENDING"
7670
},
7771
"company_id": "00000000-0000-0000-0000-000000000000",
7872
"applicant": {
7973
"id": "00000000-0000-0000-0000-000000000000",
8074
"first_name": "Test",
8175
"last_name": "User",
82-
"email": "[email protected]",
83-
"phone_number": "123456789"
76+
"email": "[email protected]"
8477
},
8578
"job": {
8679
"id": "00000000-0000-0000-0000-000000000000",

0 commit comments

Comments
 (0)