job_application.created

A candidate submits an application to a job post.

postAstalty sends a POST to each webhook subscribed to this event.

Example payload

{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "event_type": "job_application.created",
  "resource": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "type": "job_application"
  },
  "data": {
    "screening_outcome": "meets_all"
  }
}

Verify the signature

import crypto from "node:crypto";

export function isFromAstalty(rawBody, signature, signingSecret) {
  const expected = crypto
    .createHmac("sha256", signingSecret)
    .update(rawBody)
    .digest("hex");

  return (
    typeof signature === "string" &&
    signature.length === expected.length &&
    crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature))
  );
}

Headers

X-Astalty-Signaturestringrequired
HMAC-SHA256 of the raw request body, keyed with the webhook's signing secret and hex encoded. See Verifying the signature.

Payload

application/json

idstring<uuid>required
The delivery ID. It stays the same across retries, so use it to ignore a delivery you have already processed.
event_typeenum<string>required
The event that occurred.
Available options:job_application.created
resourceobjectrequired
The record the event relates to.
▶Show 2 child attributesHide child attributes
- idstring<uuid>required
  The ID of the job application.
- typeenum<string>required
  Available options:job_application
dataobjectrequired
▶Show 1 child attributesHide child attributes
- screening_outcomeenum<string> | nullrequired
  How the answers scored against the job post's screening questions when the application was submitted. Staff can re-score an application later without another event, so read the application for the current value.
  Available options:meets_allmissing_must_havemissing_nice_to_have

Fetch the record

The payload names the record but does not include it. Call this endpoint with resource.id to read its current details.

getGet a Job Application/public/v1/job-applications/{jobApplication}

Return any 2xx status within 15 seconds to acknowledge the delivery. Anything else is retried up to 10 times over about 42 hours, so make your handler idempotent on the delivery id. See Retries and delivery.

Command Palette

Headers

Payload

Fetch the record

Responding