POP Engine™ Partner API Help

Notify Partner

If url field is not empty in either account config or application’s app_url field, partner will be notified accordingly upon applicant submitting completed questionnaire. If notification failed for whatever reason it will be retried accordingly to following rules: retry every second during first minute, retry every minute during first hour, retry every day after that until application expire date has reached.

Actions depending on status of the response:

Response

Action

No response

Request is added to persistent queue where it will be periodically retried until a response is received or application completion date is past due. (See the Failed request retry schedule) Upon completion the request is removed from queue.

HTTP status 200

Success; no futher action taken

Other HTTP status contained in account's http_err config field

Request is added to persistent queue, as for no response

Any other http status

No further action taken

Example of extended information added as JSON to partner notification when ext_notify config field is set to yes:

{ "application_id": "10013810", "position_id": "10002063", "aname": "EPOP Leadership", "started": "2022-01-19", "completed": "2022-01-19", "report_id": "10012781", "report_name": "EPOP" }

Failed request retry schedule

Time since original request

Retry interval

During first minute

Every 1 second

During first hour

Every 1 minute

After first hour

Once daily

Last modified: 24 October 2024