Aptem Webhooks: Job type

Overview

This webhook sends notifications when client jobs are created or updated. Jobs can be managed from the Jobs page in Classic (~/Job/Jobs/Index).

The payload for a Job webhook mirrors the payload of a GetJobById API response:

  • id

  • title

  • description

  • salaryMin

  • salaryMax

  • url

  • hours

  • type

  • expirationDate

  • group

  • employer

    • id

    • name

    • category

    • address

      • Id

      • Address1

      • Address2

      • TownCity

      • CountyState

      • PostCode

    • contact

      • Id

      • Name

      • Email

      • Phone

  • caseOwner

  • wageType

  • fixedWageYearlyAmount

  • AND event (“update” or “create”)

 

Create event

For the Create event type, the webhook is sent once a new client job is created in the tenant.

Payload

The payload for Create event type includes “event”:”create” field.

Example: 

{
  "id": 19,
  "title": "Trainee Web Developer",
  "description": "We are looking to employ our Coding Traineeship graduates. The traineeship is completed in 3 easy steps. Step 1 - Front End Coding Complete a selection of coding courses (HTML, CSS and Javascript). Step 2 - Back End Coding + Practical Projects. Step 3 - Building your portfolio. Once you have completed all of the mandatory training, we will place you into a Web Development/Software Development role, where you will be guaranteed a 25k-40k salary.\r\n",
  "salaryMin": 0,
  "salaryMax": 0,
  "url": "https://fakejob.com",
  "hours": "Full or part time",
  "type": "Any contract type",
  "expirationDate": "2026-03-31T00:00:00",
  "group": 1166,
  "employer": {
    "id": 8,
    "name": "Reynolds-Bayer",
    "category": "",
    "address": {
      "Id": 27,
      "Address1": "Address1",
      "Address2": "Address2",
      "TownCity": "Town",
      "CountyState": "Country",
      "PostCode": "TEST"
    },
    "contact": {
      "Id": 1039,
      "Name": "John Text",
      "Email": "Test@test.com",
      "Phone": "012345678"
    }
  },
  "caseOwner": 1031,
  "wageType": "FixedWage",
  "fixedWageYearlyAmount": 12480,
  "event": "create"
}

 

Update event

For the Update event type, the webhook is sent when any field of an existing Client Job is updated, or when a job is re-saved without any changes.

Note: The webhook only reflects changes to fields included in the payload. For example, if a field not included in the payload (such as a Grade) is updated, the webhook will still be sent, but the payload will not include details of that change.

Payload

The payload for Update event type includes “event”:”update” field.

Example: 
{
  "id": 1,
  "title": "Job Title Here",
  "description": "Job description text goes here.\r\n",
  "salaryMin": 0,
  "salaryMax": 0,
  "url": "https://example.com",
  "hours": "Full or part time",
  "type": "Any contract type",
  "expirationDate": "2026-01-01T00:00:00",
  "group": 1000,
  "employer": {
    "id": 1,
    "name": "Example Employer Ltd",
    "category": "",
    "address": {
      "Id": 1,
      "Address1": "1 Example Street",
      "Address2": "Example Area",
      "TownCity": "Example Town",
      "CountyState": "Example County",
      "PostCode": "EX1 1AA"
    },
    "contact": {
      "Id": 1,
      "Name": "John Smith",
      "Email": "john.smith@example.com",
      "Phone": "07700 000000"
    }
  },
  "caseOwner": 1000,
  "wageType": "FixedWage",
  "fixedWageYearlyAmount": 0,
  "event": "update"
}

 

Delete event

For DELETE event type, the webhook is not supported.

Was this article helpful?
0 out of 0 found this helpful