Post Plus Dashboard API

Post Plus Dashboard API gives you the ability to post advert through Veritone Hire. This API acts in two ways: the first is advert posting and the second is advert management.

When you send us a request payload on this endpoint for the first time, it will give you a URL for posting the job through Veritone Hire. When you send the request payload again with the same unique identifier for the job already posted, it will give you a URL that will open the Manage Advert dashboard (Posting center).

The Manage Advert dashboard view encapsulates all the required functionality usable on a Veritone Hire vacancy: Publish, Rebroadcast, Edit and Delete (both global delete from all live boards or removals per board). It also provides the current live status on all boards, the posting expiry detail, the number of responses and a posting history.

Request - Advert Posting

POST https://beanwidget.adcourier.com/distro/dashboardpost

Content Type: application/json
Body:

Example Request

{
    "authentication": {
        "api_key": "123456789",
        "time": 1682406898463,
        "signature": "3c17010c43469972a61fd19940250b02b367e4a6c87f696ed4f0cd9468befc7f"
    },
    "identification": {
        "client_id": "testclient",
        "adc_username": "testuser@testing.testoffice.testclient"
    },
    "transaction": {
        "filters": {
            "job_reference": " abc12311",
            "custom_fields": [
                {
                    "name": "ATS field value e.g. Req Id",
                    "value": "12345"
                },
                {
                    "name": "Another ATS field value e.g. Publication Id",
                    "value": "12345"
                }
            ]
        },
        "advert": {
            "job_title": "Widget Manager",
            "job_reference": "abc12311",
            "job_type": "Permanent",
            "location_query": "London, England",
            "industry": "IT",
            "salary_from": 30000,
            "salary_to": 40000,
            "salary_currency": "gbp",
            "salary_per": "annum",
            "salary_benefits": "Benefits",
            "skills": "Supreme skill set",
            "summary": "Excellent summary",
            "client_details": "Details about the client",
            "job_description": "Splendid job description",
            "profile": "Profile description",
            "job_offer": "Description about the job offer",
            "custom_fields": {
                "myCustomField1": "myinternalJobID",
                "myCustomField2": "myinternalJobID2"
            }
        },
        "applyonline": {
            "url": "https://yoursite.com/jobs/1234/apply"
        },
        "stylesheet": {
            "posting_form": "https://yoursite.com/posting.css",
            "dashboard": "https://yoursite.com/dashboard.css"
        },
        "notify_on_delivery": "https://yoursite.com/jobs/1234/post_complete",
        "redirect_on_completion": {
            "url": "https://yoursite.com/jobs/1234/",
            "auto": "true"
        },
        "close_on_completion": "true"
    }
}

Example Response (200 OK)

{
    "success": 1,
    "url": "https://beanwidget.adcourier.com/one_time_token"
}

Request - Manage Advert Dashboard

POST https://beanwidget.adcourier.com/distro/dashboardpost

Content Type: application/json
Body:

Example Request

{
    "authentication": {
        "api_key": "123456789",
        "time": 1395834265000,
        "signature": "s6f74hd756heg6sgr6gfts64g6sgdf5462yehdg5fbrys7rjek9ksjurhdytchs65"
    },
    "identification": {
        "client_id": "testclient",
        "adc_username": "testuser@testteam.testoffice.testclient"
    },
    "transaction": {
        "options": {
            "behaviour_if_not_advert_owner": "view"
        },
        "filters": {
            "job_reference": "TSTJ2341",
            "custom_fields": [
                {
                    "name": "ATS_Job_Id",
                    "value": "APG12341"
                }
            ]
        },
        "advert": {
            "job_reference": "TSTJ2341",
            "custom_fields": {
                "ATS_Job_Id": "APG12341"
            }
        }
    }
}

Example Response (200 OK)

{
    "success": 1,
    "url": "https://beanwidget.adcourier.com/posting_centre/view?id=BXXX1XX-06B2-11EF-8XX1-A6607XXXXXXX4"
}

Request Fields

Level	Field	Type	Mandatory	Example Values	Notes
1	authentication	object	Y
1.1	api_key	string	Y		Unique API key for each client, supplied by Veritone Hire
1.2	time	string	Y		epoch value (as string)
1.3	signature	string	Y		SHA256/HMAC message digest encoded with shared secret key
2	identification	object	Y
2.1	client_id	string	Y		AdCourier client id
2.2	adc_username	string	Y		AdCourier (ADC) username
3	transaction	object
3.1	options	object	N		The default is none and don’t need to add unless required.
3.1.1	behaviour_if_not_advert_owner	string	Y	"none"\|"view"\|"act"	"“none” - No visibility of other peoples’ adverts (will go to Broadcast Step 1 to post a new advert). “view” - PostingCentre will open if the advert is available, but all the actions (repost, delete, etc) are disabled. “act” - PostingCentre will open if the advert is available, all the actions will work (edit, delete etc operate as the original user but posting a new version of the advert will operate as the current user)."
3.2	filters	object	Y		The filters object must contain either: a job_reference string; or a custom_fields array with at least one element.
3.2.1	job_reference	string	Y
3.2.2	custom_fields	array list	N
3.2.2.1	name	string	Y	ATS_Job_Id
3.2.2.2	value	string	Y	A12345
3.3	advert	object	Y
3.3.1	job_title	string	N
3.3.2	job_reference	string	Y
3.3.3	job_type	string	N		Refer to the English Contract Types or French contract Types on Contract-Type-and-Industry section of this documentation for values as applicable.
3.3.4	location_query	string	N	"London, England" Or "Chicago, Illinois, USA"	Location string, should always be: Place, Country
3.3.5	industry	string	N		Refer to the Global Industry Sector Values or French Industry Sector Values on Contract-Type-and-Industry section of this documentation for values as applicable.
3.3.6	salary_from	number	N
3.3.7	salary_to	number	N
3.3.8	salary_currency	string	N		any valid ISO currency
3.3.9	salary_per	string	N		enum: annum \| month \| week \| day \| hour
3.3.10	salary_benefits	string	N		max 100 chars
3.3.11	skills	string	N		max 250 chars
3.3.12	summary	string	N		max 500 chars, may contain HTML. This field is specific in markets such as the Netherlands, France, Benelux and the DACH regions. Refer to the Descriptive Fields section of this document for more info.
3.3.13	client_details	string	N		max 1500 chars, may contain HTML. This field is specific in markets such as the Netherlands, France, Benelux and the DACH regions. Refer to the Descriptive Fields section of this document for more info.
3.3.14	job_description	string	Y		max 6000 chars, may contain HTML.
3.3.15	profile	string	N		max 1500 chars, may contain HTML.This field is specific in markets such as the Netherlands, France, Benelux and the DACH regions. Refer to the Descriptive Fields section of this document for more info.
3.3.16	job_offer	string	N		max 1500 chars, may contain HTML. This field is specific in markets such as the Netherlands, France, Benelux and the DACH regions. Refer to the Descriptive Fields section of this document for more info.
3.3.17	custom_fields	object	N	"custom_fields":{ "ATS_Job_Id":"A12345", "ATS_Client_Id":"test123" }	In this you have to list all the custom fields used inside the filter section. Each value contains a name and value pair separated by comma.
3.3.18	startdate	string	N		optional vacancy extension field; should be a valid date
3.3.19	experience	array	N	"experience":[ "12", "14" ],	optional vacancy extension field
3.3.20	recsite_guid	array	N	"recsite_guid":[ "aad02518-ba41-4cb2-82ee-fdcb47351e2a", "e8a79bf9-e715-49d1-a34d-affa18d40b70" ]	optional vacancy extension field
3.4	applyonline	object	N		This is mandatory in case “Apply Online” flow.
3.4.1	url	string	N		Career website URL where a candidate will be redirected from the job board after clicking on the apply button.
3.5	stylesheet	object	N		If you want to change the look and feel of the posting form and advert management dashboard, you can provide custom CSS file links. Note: Only color scheme and logo change are allowed.
3.5.1	posting_form	string	N		CSS URL for posting form
3.5.2	dashboard	string	N		CSS URL for dashboard
3.6	notify_on_delivery	string	N		Webhook URL where you want to be notified about delivery of advert on job boards once posted to Veritone Hire.
3.7	redirect_on_completion	object	N		This will contain the details if a user should be redirected to a different page once job posting is complete. Note: You can only use one either redirect_on_ completion or close_on_completion.
3.7.1	url	URI	N		Redirect URL
3.7.2	auto	boolean \| string	N		default: “false”
3.8	close_on_completion	string	N	“true”	You can only use one either redirect_on_ completion or close_on_completion.

Response Fields

Level	Field	Type	Mandatory	Example Values	Notes
1	success	boolean	Y	1 or 0
2	url	string	Y (In case of success)		iFrame Url for posting form or manage advert dashboard
3	error	string	Y (In case of error)		Error message

Return to top

Post Plus Dashboard API

Post Plus Dashboard API

Related articles