Skip to main content
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.
FieldData TypeDefinition
created_atIntegerThe date and time at which the job was created.
error_messageStringIf the job returns an error, this field will contain the message of the error.
finished_atIntegerThe date and time at which the job finished.
guidStringThe unique identifier for the job. Defined by MX.
insitution_guidStringThe unique identifier for the institution the job is attached to. Defined by MX.
is_authenticatedBooleanInitially false for the job. The value will change to true once the credentials have been validated and any MFA challenges have been satisfied.
member_guidStringThe unique identifier for the member.
member_idStringThe unique partner-provided identifier for the member. This field can be null when member_is_managed_by_user is true.
started_atIntegerThe date and time at which the job started.
status_nameStringThe name of the job status. See the Nexus documentation for more information.
statusIntegerThe status of the job. See the Nexus documentation for more information.
updated_atIntegerThe date and time at which the job was updated.
user_guidStringThe unique identifier for the user the job is attached to. Defined by MX.
user_idStringThe unique, partner-defined identifier for the user.
Example Payload
JSON
POST /admin/webhooks
HTTP/1.1
content-type: application/json; charset=utf-8
accept: application/json
User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2
(2015-09-02)) Date: Thu, 14 Apr 2016 04:26:04 GMT Content-Length: 231
Host: abc.com
{
  "job": {
    "created_at": 1471281212,
    "error_message": null,
    "finished_at": 1471281215,
    "guid": "JOB-a177e002-e5b8-0680-3427-39556fa93c6e",
    "institution_guid": "INS-3aeb38da-26e4-3818-e0fa-673315ab7754",
    "is_authenticated": true,
    "member_guid": "MBR-48d9a481-f2a2-7e13-2685-62869cf0d33a",
    "member_id": null,
    "started_at": 1471281213,
    "status": 6,
    "status_name": "COMPLETED",
    "updated_at": 1471281218,
    "user_guid": "USR-eaf4ac68-d17d-5e9b-7b46-959a5b315a9e",
    "user_id": "7834372140"
  }
}