Initialize Job Change Tracking

POST 
/v1/jobchange/initializeJobChangeTracking

This endpoint allows our partners to setup job change tracking for their customers so that job change updates are provided per customer.

Request Body

Field	Type	Description	Required
webhook_url	string	The destination webhook URL to use for the given customer.	✅
webhook_secret	string	The webhook secret for the given webhook destination, if applicable.	❌
customer_domain	string	The domain of the customer.	✅
customer_id	string	The previously provided id of the customer.	✅

One of customer_domain or customer_id is required. Using customer_domain will setup a new customer, using customer_id will allow for modification of an existing customer.

---

Response

The endpoint returns a response with a customer ID if successful. This customer ID should be persisted by the caller to associate job change updates to a given customer.

Example Success Response

{
  "customer_id": "abcd1234"
}

---

Error Handling

The API returns appropriate error messages with status codes if something goes wrong.

Error Code	Message	Description
400	Invalid Request	Verify your request is properly formatted
401	Unauthorized	Verify you are using a valid API key
500	Internal Server Error	An unexpected error occurred.

Example Error Response

{
  "error": {
    "code": 400,
    "message":"webhook URL is required"
  }
}

Request

Responses

200

Successful response