Goals

Goals webhooks notify you when a goal is created, updated, or deleted in the MX system for any user on that partner's client.

Field	Data Type	Definition
account_guid	String	The unique identifier for the goal. Defined by MX.
amount	Decimal	The amount of the goal.
completed_at	Integer	The date and time at which the goal was completed.
created_by	String	The source that created the goal. Possible values are USER and SYSTEM. This is a new field that is not yet being populated and will return null values at this time.
current_amount	Decimal	The current amount of the goal.
goal_type_name	String	The type of goal. Can be SAVE_AMOUNT or PAYOFF.
guid	String	The unique identifier for the goal. Defined by MX.
has_been_spent	Boolean	This indicates whether the goal has been spent.
is_complete	Boolean	This indicates whether the goal is complete.
meta_type	String	The category of the goal.
metadata	String	Additional information a partner can store on the goal.
name	String	The name of the goal that is visible to the user.
position	Integer	The priority of the goal in relation to multiple goals.
projected_to_complete_at	Integer	The date and time at the goal is projected to be completed.
revision	Integer	The revision number for the goal.
user_guid	String	The unique identifier for the user the goal is attached to. Defined by MX.
user_id	String	The unique partner-defined identifier for the user.

Example Payload

_29

POST /admin/webhooks

_29

HTTP/1.1

_29

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

_29

accept: application/json

_29

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

_29

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

_29

Host: abc.com

_29

{

_29

"action": "created",

_29

"goal": {

_29

"account_guid": "ACT-1c935fd7-cd39-18b7-1e5b-71fbde730bd6",

_29

"amount": 750,

_29

"completed_at": null,

_29

"created_by": null,

_29

"current_amount": 100,

_29

"goal_type_name": "SAVE_AMOUNT",

_29

"guid": "GOL-537e6391-3c29-9130-4d4f-e44302608406",

_29

"has_been_spent": false,

_29

"is_complete": false,

_29

"meta_type": "OTHER",

_29

"metadata": null,

_29

"name": "Home",

_29

"position": 2,

_29

"projected_to_complete_at": 1491004799,

_29

"revision": 71,

_29

"user_guid": "USR-dfb1b536-692d-f172-88c6-643a2691b30c",

_29

"user_id": "0128372140"

_29

}

_29

}