v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Webhook Payloads

candidateStageChange

Triggered when a candidate changes stages in an application. Also triggered by candidateHire

postWebhookcandidateStageChange

Payload

action'candidateStageChange' required

Example payload

{
  "data": {
    "application": {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "createdAt": "2022-08-12T20:29:56.964Z",
      "updatedAt": "2022-08-12T20:29:56.964Z",
      "customFields": [
        {
          "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
          "title": "Is actively looking",
          "value": true
        }
      ],
      "candidate": {
        "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
        "name": "James",
        "primaryEmailAddress": {
          "value": "test@ashbyhq.com",
          "type": "Work",
          "isPrimary": true
        },
        "primaryPhoneNumber": {
          "value": "222-222-3344",
          "type": "Work",
          "isPrimary": true
        }
      },
      "currentInterviewStage": {
        "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
        "title": "Offer",
        "type": "Offer",
        "orderInInterviewPlan": 1006,
        "interviewStageGroupId": "5f7b3b3b-7b1b-4b1b-8b3b-7b1b4b1b8b3b",
        "interviewPlanId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
      },
      "source": {
        "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
        "title": "Applied",
        "sourceType": {
          "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
          "title": "Inbound"
        }
      },
      "archiveReason": {
        "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
        "text": "Too inexperienced",
        "reasonType": "RejectedByOrg",
        "customFields": [
          {
            "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
            "title": "Is actively looking",
            "value": true
          }
        ]
      },
      "archivedAt": "2022-08-12T20:29:56.964Z",
      "job": {
        "id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
        "title": "First Designer",
        "locationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
        "departmentId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
      },
      "creditedToUser": {
        "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
        "firstName": "Test",
        "lastName": "User",
        "email": "test@ashbyhq.com",
        "updatedAt": "2022-08-12T20:29:56.964Z",
        "managerId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
        "customFields": [
          {
            "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
            "title": "Is actively looking",
            "value": true
          }
        ]
      },
      "hiringTeam": [
        {
          "email": "test@ashbyhq.com",
          "firstName": "Joey",
          "lastName": "Joe",
          "role": "Hiring Manager",
          "userId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
        }
      ],
      "appliedViaJobPostingId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "submitterClientIp": "79.255.55.222",
      "submitterUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36"
    }
  }
}

Response

Return a 200 status to indicate that the data was received successfully