Job Status

Job status webhooks notify you when a job hits an actionable state. These actionable states parallel the states that you monitor if using the read job endpoint in Nexus. This allows webhooks to completely replace using read job pings from the Nexus API.

The actionable states that will initiate delivery of a webhook event are: DENIED, PREVENTED, HALTED, COMPLETED, and CHALLENGED.

Field	Data Type	Definition
created_at	Integer	The date and time at which the job was created.
error_message	String	If the job returns an error, this field will contain the message of the error.
finished_at	Integer	The date and time at which the job finished.
guid	String	The unique identifier for the job. Defined by MX.
insitution_guid	String	The unique identifier for the institution the job is attached to. Defined by MX.
is_authenticated	Boolean	Initially false for the job. The value will change to true once the credentials have been validated and any MFA challenges have been satisfied.
member_guid	String	The unique identifier for the member.
member_id	String	The unique partner-provided identifier for the member. This field can be null when member_is_managed_by_user is true.
started_at	Integer	The date and time at which the job started.
status_name	String	The name of the job status. See the Nexus documentation for more information.
status	Integer	The status of the job. See the Nexus documentation for more information.
updated_at	Integer	The date and time at which the job was updated.
user_guid	String	The unique identifier for the user the job is attached to. Defined by MX.
user_id	String	The unique, partner-defined identifier for the user.

Example Payload

_25

POST /admin/webhooks

_25

HTTP/1.1

_25

content-type: application/json; charset=utf-8

_25

accept: application/json

_25

User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2

_25

(2015-09-02)) Date: Thu, 14 Apr 2016 04:26:04 GMT Content-Length: 231

_25

Host: abc.com

_25

{

_25

"job": {

_25

"created_at": 1471281212,

_25

"error_message": null,

_25

"finished_at": 1471281215,

_25

"guid": "JOB-a177e002-e5b8-0680-3427-39556fa93c6e",

_25

"institution_guid": "INS-3aeb38da-26e4-3818-e0fa-673315ab7754",

_25

"is_authenticated": true,

_25

"member_guid": "MBR-48d9a481-f2a2-7e13-2685-62869cf0d33a",

_25

"member_id": null,

_25

"started_at": 1471281213,

_25

"status": 6,

_25

"status_name": "COMPLETED",

_25

"updated_at": 1471281218,

_25

"user_guid": "USR-eaf4ac68-d17d-5e9b-7b46-959a5b315a9e",

_25

"user_id": "7834372140"

_25

}

_25

}