Webhook API Integration

Webhook API Integration

Partner job posting API documentation

NGTU Job Posting Webhook API

The Job Posting API enables partners to add, update, and delete jobs on the Not Going To Uni website via HTTP POST requests. Each request contains JSON data for one job.

General

  • Base URL: https://api.notgoingtouni.co.uk/api/webhook/

  • Content-Type: application/json

  • Authentication header: secret-key: <your_secret>

Your secret-key is issued when an NGTU admin creates your webhook partner record in the admin panel (Admin → Webhook Setup).

API Endpoints

1) Add or update a job

URL: POST https://api.notgoingtouni.co.uk/api/webhook/opportunities/add

To update an existing job, call the same endpoint again with the same reference_id. All fields are overwritten.

FieldRequiredExplanation reference_idYesUnique job ID from your system (e.g. VAC-04730). Alias: job_reference_id titleYesJob title company_nameYesEmployer name (must match NGTU provider, or webhook partner fallback) countyYesArray of counties (same length as town) townYesArray of towns (same length as county) opportunity_typeYesNGTU opportunity type name (e.g. INTERMEDIATE APPRENTICESHIP). Alias: category_id sectorYesNGTU sector name (e.g. SCIENCE & MEDICINE). Alias: sector_id application_linkYesExternal apply URL descriptionYesJob description (HTML allowed) salaryNoYearly salary amount application_emailNoEmail for applications live_fromNoGo-live date (Y-m-d) endNoClosing date (Y-m-d)

2) Delete a job

URL: POST https://api.notgoingtouni.co.uk/api/webhook/opportunities/delete

FieldRequiredExplanation reference_idYesJob reference ID previously submitted via add

Demo — Postman / local test

Headers:

Content-Type: application/json
secret-key: sk_your_webhook_secret_here

Sample JSON body (add):

{
  "reference_id": "VAC-04730",
  "title": "Pharmacy Assistant Apprenticeship",
  "company_name": "Skills4Group",
  "county": ["Greater Manchester"],
  "town": ["ALTRINCHAM"],
  "opportunity_type": "INTERMEDIATE APPRENTICESHIP",
  "sector": "SCIENCE & MEDICINE",
  "application_link": "https://example.com/apply?vac=04730",
  "description": "Pharmacy Assistant Apprenticeship role with training provided.",
  "salary": "18720",
  "application_email": "[email protected]",
  "live_from": "2026-07-09",
  "end": "2026-07-24"
}

Responses

Success (HTTP 200):

{
  "success": true,
  "message": "Your Opportunities submitted",
  "data": { "opportunity_id": 12345, "job_reference_id": "VAC-04730" },
  "reference_id": "VAC-04730"
}

Error format:

{
  "success": false,
  "message": "Human-readable summary",
  "error_code": "COMPANY_NOT_FOUND",
  "errors": [{ "field": "company_name", "value": "...", "message": "...", "hint": "..." }],
  "reference_id": "VAC-04730"
}

HTTPerror_codeMeaning 401AUTH_MISSINGsecret-key header missing 401AUTH_INVALIDInvalid or inactive secret-key 422VALIDATION_FAILEDField validation failed 422COMPANY_NOT_FOUNDCompany not found in NGTU 422OPPORTUNITY_TYPE_NOT_FOUNDInvalid opportunity type 422COUNTY_NOT_FOUNDCounty could not be resolved 422TOWN_NOT_FOUNDTown could not be resolved 422COUNTY_TOWN_MISMATCHCounty/town array length mismatch 422REFERENCE_NOT_FOUNDDelete: reference not found 500SERVER_ERRORUnexpected server error

Helper endpoints (valid values)

  • GET https://api.notgoingtouni.co.uk/api/webhook/get-company-data — active companies (id, slug, name)

  • GET https://api.notgoingtouni.co.uk/api/webhook/get-opportunity-type — active opportunity types (id, slug, name)

  • GET https://api.notgoingtouni.co.uk/api/webhook/get-sector-data — active sectors (id, slug, name)

  • GET https://api.notgoingtouni.co.uk/api/webhook/get-region-data — active counties (id, slug, name)

  • GET https://api.notgoingtouni.co.uk/api/webhook/get-county-data — active counties (id, slug, name)

  • GET https://api.notgoingtouni.co.uk/api/webhook/get-town-data?county_id= — active towns for a county (id, slug, name)

Approval workflow

When a job is received via API it goes into review on the NGTU backend. A super admin / customer success user approves or declines before the job appears on the public website.

Field entry options

If a value does not match NGTU options, it may be stored as Other and the NGTU team will follow up.

Opportunity Type

ALTERNATIVE COURSES/DEGREES, ADVANCED APPRENTICESHIP, COLLEGE COURSES, COLLEGE HIGHER EDUCATION, DEGREE APPRENTICESHIP, DISTANCE/ONLINE LEARNING, EMPLOYMENT & TRAINING, FULL TIME JOB, GAP YEAR, HIGHER APPRENTICESHIP, HTQs (Higher Technical Qualifications), INTERMEDIATE APPRENTICESHIP, INTERNSHIP, JOB GROWTH WALES +, PART TIME JOB, PROFESSIONAL QUALIFICATIONS, SCHOOL LEAVER, SPONSORED DEGREE, T LEVELS, VOLUNTEERING, WORK EXPERIENCE

Sector

ACCOUNTING & FINANCE, AUTOMOTIVE & MECHANICS, ANIMAL CARE/TRAINING, BUSINESS & ADMINISTRATION, BEAUTY & WELLNESS, CUSTOMER SERVICE, CREATIVE, MEDIA & DESIGN, CONSTRUCTION & TRADES, CHILD CARE/EARLY YEARS, DENTISTRY, ENGINEERING, ENVIRONMENT & LAND, EVENT MANAGEMENT, GOVERNMENT SERVICES & PUBLIC SECTOR, HEALTH & SOCIAL CARE, HOSPITALITY & CATERING, IT & TECHNOLOGY, JOURNALISM, LAW & INSURANCE, MANAGEMENT, MANUFACTURING & SUPPLY CHAIN, MARKETING & SOCIAL MEDIA, RETAIL & SALES, SCIENCE & MEDICINE, SPORTS & LEISURE, TRANSPORT & LOGISTICS, TEACHING ASSISTANT

Any queries please contact your regular NGTU contact.

Last updated 13/09/2026