Creating a Webhook

Create an HTTP endpoint

Webhooks must have an endpoint to receive the data payload that they send out. For this exercise, we will create a temporary endpoint with RequestBin.

Create Endpoint

Create a public bin/endpoint to receive the HTTP POST from the webhook.

Copy URL

Copy the public URL of your new endpoint.

Create a Webhook in BrightMove

In BrightMove, Click on your Profile Image, then choose Settings.

In the Utilities panel, choose Webhooks and you will be taken to the Webhooks management screen.

Choose the New Webhook button from the management screen, then paste the URL from the previous step into the Target URL field, and choose the Webhook Event you would like sent to the URL.

For this example choose new_applicant

Fire off your Event

Create a new applicant in BrightMove. You can create one manually or parse a resume. Any new applicant will fire the webhook event and post the payload to your webhook.

Inspect the payload

Back in your browser tab where you created your HTTP URL with RequestBin, you will see the payload of the new applicant you just created.

BrightMove webhooks POST payloads as JSON. Here is a real JSON example of the payload shown above.

1{
2    "id": 32456288,
3    "guid": "C365A4CF-0CDE-3583-E053-0100007F8283",
4    "firstName": "Bob",
5    "middleName": "Lawrence",
6    "lastName": "Seidel",
7    "email": "bob@wecleanhouse.net",
8    "workEmail": "bob.work@mailinator.com",
9    "type": 2,
10    "phones": [
11        {
12            "type": "Mobile",
13            "phoneNumber": "9045551212"
14        }
15    ],
16    "emailAllowed": true,
17    "smsAllowed": true,
18    "location": {
19        "address1": "1234 Main Street",
20        "address2": "Suite 650",
21        "city": "Chicago",
22        "state": {
23            "id": 14,
24            "name": "Illinois",
25            "abbrev": "IL",
26            "country": {
27                "id": 1,
28                "code": "US",
29                "name": "UNITED STATES"
30            }
31        },
32        "postalCode": "60601"
33    },
34    "primarySkills": "Workforce reduction",
35    "source": "ZipRecruiter",
36    "currentCompany": "Inetec",
37    "currentTitle": "Manager",
38    "currentPay": {
39        "rate": 100000,
40        "type": "Annually"
41    },
42    "desiredPay": {
43        "rate": 105000,
44        "type": "Annually"
45    },
46    "displayName": "Bob Seidel"
47}

Conclusion

Congratulations! You just create and inspected your first BrightMove webhook. With webhooks, you can extend the functionality of your ATS in many ways. Have fun exploring all the possibilities.