API Reference
API Reference

Candidate Events

The data that Workable pushes when an event gets triggered is similar to candidate details endpoint.

keytypedescription
dataobjectData wrapper
data.accountobjectAccount wrapper
data.account.namestringThe name of the account
data.account.subdomainstringThe subdomain of the account
data.addressstringThe address of the candidate
data.cover_letterstringThe cover letter provided when candidate applied
data.created_attimestampThe timestamp the candidate created
data.disqualifiedbooleanIndicates if the candidate is disqualified
data.disqualification_reasonstringThe reason the candidate was disqualified
data.disqualified_attimestampThe timestamp the candidate was disqualified
data.domainstringThe domain of the referrer site that linked to the job page or the job board the job advertised
data.education_entriesarrayA collection with education entries
data.education_entry.idstringEducation entry identifier
data.education_entry.degreestringThe graduation degree
data.education_entry.schoolstringThe name of the school graduated
data.education_entry.field_of_studystringThe field of study
data.education_entry.start_datedateThe date started
data.education_entry.end_datedateThe date ended
data.emailstringThe email address of the candidate
data.experience_entriesarrayA collection with working experience entries
data.experience_entry.titlestringThe title of the experience entry
data.experience_entry.companystringThe company name
data.experience_entry.summarystringThe summary of the experience entry
data.experience_entry.industrystringThe industry of the company
data.experience_entry.start_datedateThe date started
data.experience_entry.end_datedateThe date ended
data.experience_entry.currentbooleanIndicates if currently works there
data.firstnamestringThe first name of the candidate
data.headlinestringThe headline of the candidate
data.idstringThe candidate identifier
data.image_urlurlUrl of candidate's avatar. Available only if provided by the candidate
data.jobobjectJob wrapper
data.job.shortcodestringThe shortcode of the job
data.job.titlestringThe title of the job
data.lastnamestringThe last name of the candidate
data.namestringThe full name of the candidate
data.outbound_mailboxstringMailbox that can be used to communicate with the candidate and inform the recruitment team of the job as well
data.phonestringThe phone number of the candidate
data.profile_urlurlUrl to the candidate's profile
data.resume_urlurlUrl to the candidate resume
data.skillsarrayA collection with skill names
data.social_profilesarrayA collection with social profiles of the candidate
data.social_profile.typestringThe slug name of the social profile. It can be one of the following types: academiaedu, angellist, behance, bitbucket, blogger, crunchbase, dandyid, delicious, deviantart, digg, doyoubuzz, dribble, dribbble, econsultancy, facebook, flavorsme, flickr, fullcontact, getglue, gist, github, goodreads, googleplus, gravatar, hackernews, hiim, klout, lanyrd, linkedin, myspace, ohloh, orkut, pinterest, quora, reddit, scribd, skype, slideshare, stackexchange, stackoverflow, tumblr, twitter, typepad, vk, wordpress, xing
data.social_profile.namestringThe full name of the social profile
data.social_profile.urlurlUrl to the candidate's social profile page
data.sourcedbooleanIndicates if the candidate is sourced true or applied false
data.stagestringThe name of the current stage. See stages endpoint
data.summarystringThe summary of the candidate
data.tagsarrayA collection with tags
data.updated_attimestampThe timestamp the candidate last updated
data.uploader_idstringThe id of the member uploaded the candidate.
event_typestringThe type of the event
fired_attimestampThe date the event was triggered
ididThe event identifier
resource_typestringThe type of the payload resource

Example Payload

{
  "data": {
    "account": {
      "name": "Groove Tech",
      "subdomain": "groove-tech"
    },
    "address": "25772 Gustave Shore, Iowa, USA",
    "cover_letter": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
    "created_at": "2015-07-09T10:55:53Z",
    "disqualification_reason": null,
    "disqualified": false,
    "disqualified_at": null,
    "domain": null,
    "education_entries": [
      {
        "degree": "MBA",
        "end_date": "2011-03-30",
        "field_of_study": null,
        "school": "University of Pennsylvania",
        "start_date": "2008-03-01"
      },
      {
        "degree": "B.S.",
        "end_date": "2007-03-30",
        "field_of_study": "Marketing Communication & Economics",
        "school": "University of Chicago",
        "start_date": "2004-09-01"
      }
    ],
    "email": "[email protected]",
    "experience_entries": [
      {
        "company": "Vox Mobile",
        "current": false,
        "end_date": "2014-03-30",
        "industry": "Telecommunications",
        "start_date": "2011-03-01",
        "summary": null,
        "title": "Sales Director"
      }
    ],
    "firstname": null,
    "headline": "Professional Administration Manager",
    "id": "3fc9a80f",
    "image_url": null,
    "job": {
      "shortcode": "GROOV005",
      "title": "Office Manager"
    },
    "lastname": null,
    "name": "Jj Botha",
    "outbound_mailbox": "[email protected]",
    "phone": "1-859-557-6573",
    "profile_url": "https://groove-tech.workable.com/backend/jobs/376844767/candidates/1070179133",
    "resume_url": null,
    "skills": [
      {
        "name": "travel planning"
      },
      {
        "name": "problem solving"
      }
    ],
    "social_profiles": [
      {
        "type": "twitter",
        "url": "http://www.twitter.com/jj_botha",
        "username": "jj_botha"
      },
      {
        "type": "linkedin",
        "url": "http://www.linkedin.com/in/jj_botha"
      },
      {
        "type": "googleplus",
        "url": "https://plus.google.com/6908286706342698"
      }
    ],
    "sourced": true,
    "stage": "Hired",
    "summary": "A focused, results-driven team player with many year experience in the field. Working my way up to management level, I have experience in every aspect of this role. I understand the challenges it brings, and have a proven track record of providing solutions.",
    "tags": [],
    "updated_at": "2015-07-09T10:55:53Z",
    "uploader_id": null
  },
  "event_type": "candidate_moved",
  "fired_at": "2017-03-27T09:32:45Z",
  "id": "1b1c8399",
  "resource_type": "candidate"
}