What the Careers connector can do

The Careers connector can do most of what the Careers admin does, on the one workspace you connected. This page covers what to ask it, what it can't reach, and every tool it offers.

Changes made through the connector are real. They change your workspace the same way the admin would, including your live careers site.

Tell it the job first

The connector works best on one piece of work at a time. Say what you want done, such as "connect our Ashby account" or "build a page from this mockup", and the client picks the matching set of tools. If you're not sure where to start, ask what it can do on Voyse.

The kinds of work it's set up for:

Work	What it covers
Workspace essentials	Site name, logo, main website, favicon, social accounts and default sharing image
Templates	Build or change a template, including from a mockup you share
Pages	Create, rename, publish or unpublish a page, choose its template, set the homepage
Applicant tracking	Save your ATS credentials, test them, run an import and check jobs appear on the site
Custom domain	Set up your domain, give you the DNS records to add, and confirm it is live
Jobs	Add, edit, archive or delete jobs created in Voyse
Analytics	Report on traffic, applications and the apply funnel for your live site
Site review	Check a published page before or after launch

What it can't reach

• Applications and candidates. No tool reads applications, candidate details or the talent pipeline. Analytics are totals and rates, never individual people.
• Roles from your ATS. It can read imported roles, but it won't edit or delete them. Change those in your ATS, as in the admin.
• Saved ATS credentials. It can save and test them. When it reads them back, secret values show as [redacted].
• Everything else outside the list below. Team members, billing and data requests aren't part of the connector.

If a change is refused

When the client connected, it asked for either read access alone or read and write access. If it asked for read access alone, tools that change things reply "This tool requires voyse/write. Reconnect the Voyse connector with the required scope and try again." voyse_session_init is refused the same way, even though it changes nothing. Which access a client asks for is up to the client, so check its connector settings.

Limits

• Up to 60 calls a minute to tools that read, 20 to tools that change something, and 10 to tools that take a while. Past that, the reply says how many seconds to wait.
• Mockup files you share are kept for 24 hours. Each file can be up to 5MB, and a workspace can hold 50 at a time.
• A connection that is idle for 15 minutes closes. Your next request opens a new one.

Every tool

Tools marked Changes alter your workspace. Tools marked Removes delete something or replace it, and can't be undone from the connector.

Getting started

Tool	What it does
voyse_intro	Describes what the connector can do and suggests where to start for your workspace	Reads
voyse_session_init	Picks the kind of work for this conversation and loads its tools	Changes
voyse_session_status	Checks that the connection is alive	Reads

Workspace

Tool	What it does
careers_get_tenant_metadata	Reads the site name, logo, website, favicon, social accounts and default sharing details	Reads
careers_set_tenant_metadata	Changes those details	Changes
careers_describe_tenant_conventions	Summarises patterns your existing templates share, such as reused images and colours	Reads
careers_describe_careers_site_structure	Explains how pages, jobs and templates fit together	Reads

Templates

Tool	What it does
careers_list_templates	Lists templates, with their type and which is the default	Reads
careers_get_template	Reads one template in full or in part	Reads
careers_list_template_rows	Summarises a template's rows	Reads
careers_preview_template	Shows a template rendered with sample data	Reads
careers_describe_preview_fixtures	Describes the sample data previews use	Reads
careers_create_template	Creates a template	Changes
careers_create_template_and_set_default	Creates a template and makes it the default for its type	Changes
careers_update_template	Changes part of a template	Changes
careers_set_default_template	Makes a template the default for its type	Changes
careers_assign_template_to_jobs	Assigns a job template to jobs	Removes
careers_apply_chrome_to_templates	Applies a shared header and footer to several templates	Removes
careers_delete_template	Deletes a template. Pages and jobs using it move to the default	Removes

Template reference

These explain how templates are built, so the client can write one correctly. None of them change anything.

Tool	What it does
careers_describe_template_properties	Every template, row and component property	Reads
careers_list_component_types	The components a template row can use	Reads
careers_describe_custom_component	What one of your workspace's own components does	Reads
careers_get_component_registration_guide	How a new component of your own gets added	Reads
careers_describe_custom_template_component	How a custom block of a template works	Reads
careers_describe_liquid_scope	The values and filters a custom block can use	Reads
careers_list_custom_template_starters	Example custom blocks to start from	Reads
careers_lint_custom_template_source	Checks a custom block for problems before it's saved	Reads
careers_list_schematics	Lists starter templates	Reads
careers_get_schematic	Reads a starter template	Reads
careers_describe_video_pipeline	How video is handled on a careers site	Reads
careers_describe_font_policy	Which fonts a template can use, and how	Reads

Shared components

Tool	What it does
careers_list_custom_components	Lists your shared components and where each is used	Reads
careers_save_custom_component	Adds a shared component	Changes
careers_promote_custom_component	Turns a block in one template into a shared component	Changes
careers_update_custom_component	Changes a shared component	Changes
careers_set_component_props	Changes the settings of one use of a component	Changes
careers_delete_custom_component	Deletes a shared component	Removes

Mockups and builds

Tool	What it does
careers_upload_mockup_file	Shares a mockup file with the connector	Changes
careers_create_mockup_upload	Starts sharing a large mockup file	Changes
careers_finalize_mockup_upload	Finishes sharing a large mockup file	Changes
careers_list_mockup_files	Lists the mockup files shared in the last 24 hours	Reads
careers_get_mockup_file_content	Reads a shared mockup file	Reads
careers_delete_mockup_file	Deletes a shared mockup file	Removes
careers_audit_mockup	Works out how to build a mockup, without changing anything	Reads
careers_build_from_plan	Builds what that plan describes	Changes
careers_get_build_log	Reads the record of a build	Reads

Media and fonts

Tool	What it does
careers_list_media	Lists your media library	Reads
careers_list_videos	Lists your videos	Reads
careers_upload_media_from_url	Adds an image to your library from a web address	Changes
careers_ensure_media_assets	Adds a set of images to your library	Changes
careers_resolve_cloudinary_url	Finds an image already in your library from its address, and adds it to the library if needed	Changes
careers_delete_media_asset	Deletes an image or video	Removes
careers_list_font_assets	Lists your fonts	Reads
careers_inspect_font_asset	Reads the family and weight of a font in your library	Reads
careers_ensure_font_assets	Adds a set of fonts	Changes
careers_delete_font_asset	Deletes a font	Removes

Pages

Tool	What it does
careers_describe_page_properties	Explains what a page holds and what its template holds	Reads
careers_list_pages	Lists pages	Reads
careers_get_page	Reads one page	Reads
careers_create_page	Creates a page	Changes
careers_create_page_and_set_default	Creates a page and makes it the homepage	Changes
careers_update_page	Renames, moves, publishes or unpublishes a page, or changes its template or job filter	Changes
careers_set_default_page	Makes a page the homepage	Changes
careers_set_page_metadata	Sets a page's title, description and sharing image	Changes
careers_delete_page	Deletes a page	Removes

Jobs

Tool	What it does
careers_describe_job_properties	Explains the fields a job has and the values they accept	Reads
careers_list_jobs	Lists jobs	Reads
careers_get_job	Reads one job	Reads
careers_create_job	Creates a job in Voyse	Changes
careers_update_job	Changes a job created in Voyse, including archiving it	Changes
careers_delete_job	Deletes a job created in Voyse. Its applications are archived, and its page stops working	Removes

To take a role off the site without losing its applications, ask for it to be archived rather than deleted.

Applicant tracking

Tool	What it does
careers_list_supported_ats	Lists the systems you can connect: Greenhouse, Ashby, Lever, Workable, SmartRecruiters and Pinpoint	Reads
careers_set_ats_credentials	Saves your ATS credentials	Changes
careers_set_ats_credentials_and_test	Saves your ATS credentials and tests them	Changes
careers_test_ats_connection	Tests the saved credentials	Reads
careers_get_ats_status	Reads whether your ATS is connected and when it last imported	Reads
careers_trigger_import	Imports jobs from your ATS now	Changes
careers_wait_for_import	Waits for an import to finish	Reads
careers_verify_public_jobs	Checks jobs are showing on your live site	Reads

Custom domain

Tool	What it does
careers_configure_domain	Sets up your domain and returns the DNS records to add	Changes
careers_verify_domain_records	Checks your DNS records, and switches your domain on once they're all in place	Changes
careers_wait_for_domain_edge	Waits until your domain serves the site securely, then switches it on	Changes
careers_unbind_domain	Takes your domain off the site	Removes

Analytics

Tool	What it does
careers_get_analytics_overview	Traffic, applications, apply rate and the apply funnel, against the previous period	Reads
careers_list_analytics_metrics	Lists the figures available	Reads
careers_get_analytics_metric	Reads one figure, for the whole site or one job, language or page	Reads
careers_describe_analytics_measurement	Explains how the site is measured, before figures are read	Reads

Site review

Tool	What it does
careers_describe_audit_requirements	Explains what an audit needs	Reads
careers_audit_page	Checks a published page and reports what passed and what didn't	Reads
record_acknowledgement	Notes a concern you've accepted, so it isn't raised again in this conversation	Changes
careers_list_acknowledgements	Lists concerns you've accepted	Reads
careers_clear_acknowledgement	Removes a concern you'd accepted	Changes

The connector also offers reference material your client can read, such as the shape of a template and your workspace's details. It changes nothing.