Webhooks

Overview

There are certain key events in the interview suite (e.g. the status of a Project changes). Everytime such an event is happening the system is able to trigger registered webhooks to external systems (such as an ATS, a CRM or any other third party web service).

The big benefit of working with webhooks is that the integration becoming lightweight because updates happen only when the event occurs with no necessity of polling the API.

Note

For now webhooks need to be registered by viasto per Company. Please contact the helpdesk in order to set up a webhook and include information about event and endpoint for it.

Protocol

Method	POST
Content-Type	application/json
User Agent	interview suite webhook

Payload

{
  "endpoint": "https://abc.com/project",
  "time": "2015-03-16T15:32:34.174752+00:00",
  "event": "project_changed",
  "data": {
    "project": "https://interview-suite.com/api/v3/companies/1/projects/17/"
  }
}

Standard attributes:

event	event that triggered the webhook
time	when webhook was triggered, server time in ISO 8601 format
endpoint	URL that was supposed to be called

Events

project_changed

This event is triggered every time a Project was either created or just updated.

Data:

action	created or modified
project	resource URL for the project

candidate_changed

This event is triggered every time a Candidate was either created or just updated.

Data:

action	created or modified
project	resource URL for the candidate’s project
candidate	resource URL for the candidate

answervideo_changed

This event is triggered every time an Answer Video was either created or just updated.

Data:

action	created or modified
project	resource URL for the answer video’s project
candidate	resource URL for the answer video’s candidate
question	resource URL for the answer video’s question
answervideo	resource URL for the answer video

rating_changed

This event is triggered every time a Rating was either created or just updated.

Data:

action	created or modified
project	resource URL for the rating’s project
candidate	resource URL for the rating’s candidate
rating	resource URL for the rating

note_changed

This event is triggered every time a Note was either created or just updated.

Data:

action	created or modified
project	resource URL for the note’s project
customer	resource URL for the note’s customer
answervideo	resource URL for the note’s answer video
candidate	resource URL for the note’s candidate
note	resource URL for the note