Opportunity Platform Developers
All guides

Reference

Ways to connect

Choose how to connect

There is more than one way in. Some take minutes and no developer; some are built for software teams. Pick by what you already have and what you want back.

Which should I choose?

  • If you
    Have no developer and no careers site
    Start with
    Post roles in your dashboard and switch on your careers page.
  • If you
    Already advertise on a careers page or an ATS board
    Start with
    Link your jobs and switch on your careers page: your linked roles appear on it. Two-way ATS connection is coming.
  • If you
    Have a website and want local roles on it
    Start with
    The jobs widget.
  • If you
    Are building a product or a reporting integration
    Start with
    The partner API, plus webhooks for things that happen.
  • If you
    Run a job board or an aggregator
    Start with
    Our job board feeds, or the partner API for filtered reads.
  • If you
    Want answers without building anything

The options combine. A common set-up is a linked ATS board, a careers page and the widget on a scheme website.

Every option, side by side

Live means it works on the live service today. Coming means it is not available yet; we will say so here when it is.

  • Effort
    Minutes. No developer.
    Which way data flows
    Your roles come in to us.
    Status
    Live
  • Option
    Job feed
    Effort
    Minutes if you already have a feed. Hours for a developer to publish one.
    Which way data flows
    Your roles come in to us.
    Status
    Live A plain JSON feed is not read yet.
  • Effort
    Minutes. Whoever edits your website.
    Which way data flows
    Live roles go out from us to your page. Residents apply on our site.
    Status
    Live
  • Effort
    Minutes in your dashboard settings. Your own domain needs two or three DNS records and goes live by itself once they check out.
    Which way data flows
    Your roles, posted on the platform or linked from your own site, are shown on the page.
    Status
    Live Own domain: Live, self-serve. Not included in a free trial.
  • Effort
    None for employers. A one-off set-up per board.
    Which way data flows
    Live roles go out from us to the boards.
    Status
    Live
  • Effort
    A developer, a few hours. Keys are self-serve.
    Which way data flows
    Data goes out from us when you ask for it.
    Status
    Live
  • Option
    Webhooks
    Effort
    A developer, a few hours.
    Which way data flows
    Events are pushed out from us to you.
    Status
    Live Set up in your dashboard under API access, Webhooks, or by API with a key.
  • Effort
    Minutes. No developer.
    Which way data flows
    Your assistant reads from us, signed in as you. It can also save a role as a draft.
    Status
    Live
  • Effort
    To be confirmed.
    Which way data flows
    Both ways.
    Status
    Coming

Each option in detail

  • Link your jobs

    Live
    What it is
    Paste the address of your careers page or your ATS job board. We read your live roles from it.
    Who it suits
    Employers who already advertise roles somewhere else.
    Effort
    Minutes. No developer.
    What you get
    Your roles in front of local residents, on your careers page and in your widget, kept in step with your site twice a day. Residents apply through your own apply page.
    Which way data flows
    Your roles come in to us.

  • Job feed

    Live A plain JSON feed is not read yet.
    What it is
    The same connection, pointed at an XML or RSS job feed, or a careers page carrying structured job data (schema.org JobPosting).
    Who it suits
    Employers whose ATS can publish a feed, or whose careers pages are built for search engines.
    Effort
    Minutes if you already have a feed. Hours for a developer to publish one.
    What you get
    The most reliable import: titles, locations and closing dates read field by field.
    Which way data flows
    Your roles come in to us.

  • Jobs widget

    Live
    What it is
    Two lines of HTML that show a live, always current list of opportunities on your own website.
    Who it suits
    Councils, developers, charities and employers with a website.
    Effort
    Minutes. Whoever edits your website.
    What you get
    A list filtered to your scheme, borough, type or employer that resizes to fit, with views counted. Filtered to an employer, it includes their linked roles too.
    Which way data flows
    Live roles go out from us to your page. Residents apply on our site.

  • Careers page

    Live Own domain: Live, self-serve. Not included in a free trial.
    What it is
    A hosted page for your organisation with your logo, brand colour, an introduction and every live role, at /careers/at/your-name or on your own domain.
    Who it suits
    Employers without a careers site, or who want one for their local roles.
    Effort
    Minutes in your dashboard settings. Your own domain needs two or three DNS records and goes live by itself once they check out.
    What you get
    A shareable careers page that stays current. Signing in and applying happen on opportunityplatform.co.uk.
    Which way data flows
    Your roles, posted on the platform or linked from your own site, are shown on the page.

  • Job board feeds

    Live
    What it is
    Public XML feeds of the live roles employers post on the platform, for Indeed, Reed, LinkedIn and other aggregators. Linked roles are not included.
    Who it suits
    Job boards and aggregators, and employers who want wider reach.
    Effort
    None for employers. A one-off set-up per board.
    What you get
    Roles listed on the boards, with every apply link bringing the candidate back to the platform.
    Which way data flows
    Live roles go out from us to the boards.

  • Partner API

    Live
    What it is
    A read API: live jobs, anonymous resident statistics, Section 106 progress and a developer compliance export.
    Who it suits
    Software teams building a product, job boards, councils, and ESG and reporting platforms.
    Effort
    A developer, a few hours. Keys are self-serve.
    What you get
    Structured JSON with cursor paging, published rate limits and an OpenAPI specification.
    Which way data flows
    Data goes out from us when you ask for it.

  • Webhooks

    Live Set up in your dashboard under API access, Webhooks, or by API with a key.
    What it is
    Signed HTTPS calls to your endpoint when a resident clicks or applies, an outcome is recorded or a role is published.
    Who it suits
    Employers and developers with systems that should react straight away.
    Effort
    A developer, a few hours.
    What you get
    Events within about a minute, retried over about two and a half days if your endpoint is down, with a read-back API for anything missed.
    Which way data flows
    Events are pushed out from us to you.

  • Connect your AI assistant

    Live
    What it is
    Add the platform as a connector in an AI assistant that supports the Model Context Protocol, and ask it questions about your own data.
    Who it suits
    Staff at employers, developers, councils and delivery partners.
    Effort
    Minutes. No developer.
    What you get
    Answers about your schemes, roles and Section 106 progress, limited to what your account can already see.
    Which way data flows
    Your assistant reads from us, signed in as you. It can also save a role as a draft.

  • Two-way ATS connection

    Coming
    What it is
    Applications made on the platform delivered into your ATS, and hires sent back to us as evidence.
    Who it suits
    Employers who run hiring in an ATS and report against Section 106 commitments.
    Effort
    To be confirmed.
    What you get
    One place to manage candidates, and hire evidence without re-keying.
    Which way data flows
    Both ways.

Where your roles appear

Roles reach residents by two routes, and the options above treat them differently:

  • Roles posted on the platform (in your dashboard, or by our team) appear in search, on your careers page, in the jobs widget and in the job board feeds. Residents apply on the platform, which is what records an application against a place.
  • Roles read from your own site with Link your jobs, once the connection is verified, appear in search on the platform, on your careers page (including on your own domain) and in a jobs widget filtered to your organisation. Residents who choose one go through a short step on the platform and on to your own apply page. They are not added to the job board feeds: those carry only roles posted on the platform.
Next: Connect your jobs
Choose how to connect | Opportunity Platform Developers