Sending Application Complete Events Back to Snagajob

This resource provides guidance to vendors who want to send application complete conversion events back to Snagajob for campaign optimization

To send application complete events, use the https://developers.snagajob.com/api/v1/applications/completed route. The POST supports multiple events per request while the GET supports a single event per request.

Each event must include:

• A unique Snagajob applyClickId

• Optional fields: timestamp, cost, and partnerGuid value

The POST v1/applications/completed route supports a maximum JSON data payload of 5,000 applications per request. When sending applications, please send in batches of fewer than 5,000 applications.

Authentication for event submission

Start by requesting an API Key here:

Obtaining API Access

Authenticating the request

To ensure authenticity, Snagajob requires that your API Key be sent with every request via a X-SAJ-ApiKey header or query string parameter.

These routes support signing the request as an alternative authentication method. See Generating the X-SAJ-Signaturefor more details

Submitting a Request

Route to post completed applications to snagajob

post

Authorizations

bearer

Header parameters

X-SAJ-ApiKeystringOptional

The API key provided by Snagajob. Required if not provided as query string parameter AND not using X-SAJ-Signature

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

200

OK

application/json

Responsestring

post

/v1/applications/completed

HTTPcURLJavaScriptPython

POST /v1/applications/completed HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 88

{
  "completedApplications": [
    {
      "applyClickId": "text",
      "ts": 1,
      "cost": 1,
      "partnerGuid": "text"
    }
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

text

Route to send completed applications to snagajob

get

Authorizations

bearer

Query parameters

ApplyClickIdstringRequired

The clickid parameter.

tsinteger · int64Optional

The unix timestamp in seconds

Costnumber · doubleOptional

The cost of the apply (optional)

PartnerGuidstringOptional

The partners GUID for the event

X-SAJ-ApiKeystringOptional

The API key provided by Snagajob. Required if not provided as header

Header parameters

X-SAJ-ApiKeystringOptional

The API key provided by Snagajob. Required if not provided as query string parameter AND not using X-SAJ-Signature

Responses

200

OK

application/json

Responsestring

get

/v1/applications/completed

HTTPcURLJavaScriptPython

GET /v1/applications/completed?ApplyClickId=text HTTP/1.1
Host: 
Accept: */*

200

OK

text

Parameter Descriptions

Name	Required?	Description	Type	Example
applyClickId	Yes	Snagajob's distinct click ID. When a job seeker is redirected from Snagajob to your job site, we include this ID in the redirect URL in the clickid parameter. Save this clickid and provide it with every conversion event you report for that job seeker.	string	78dbe8d7-bc12-42ba-97d8-6f7236bbb009
ts	No. If not provided, the timestamp of the conversion event will be set to UTC now.	The click event time represented as an Epoch Unix Timestamp (seconds). All clicks are recorded in Eastern Time.	int64	10111000
cost	No, but strongly encouraged	The cost of the apply conversion event.	double	2.50
partnerGuid	No, but strongly encouraged	The GUID for the event as represented in your system. We use this value to ensure that our system only processes distinct events.	string	21AVAERGHGA3

Obtaining Snagajob’s applyClickId for your requests

When a worker clicks the 'Apply Now' button, the Snagajob applyClickId is added to the URL as a parameter (clickid).

For example, the URL may look like this: https://ats.com?&applyintenteventid=644b5b52-34a1-4cb7-beac-996438d4cdd6&clickid=334c870a-8049-4f4f-a7f3-d75119dd4ab8&postingid=502840248

You'd set 334c870a-8049-4f4f-a7f3-d75119dd4ab8, obtained from the clickid parameter, as the value for applyClickId.

If your system requires a different parameter name to capture our value, please let us know, and we will do our best to help.