{"_id":"5852b4c088b5e82f0074809b","githubsync":"","project":"556dd000d0f4740d00380dfd","version":{"_id":"556dd000d0f4740d00380e00","project":"556dd000d0f4740d00380dfd","__v":14,"createdAt":"2015-06-02T15:47:12.583Z","releaseDate":"2015-06-02T15:47:12.583Z","categories":["556dd001d0f4740d00380e01","556e17023f11b01900a36978","556eff53fc3aa80d00e1aa67","557078cf910c090d00c43414","557078dc9ea7860d008b24ed","5571a533dbb3632100974aed","5571c4ed6d8908230061f39e","5575b9b10b81dc230069c981","5580706cbe698419008f2ca7","55a4117d53611017004387d4","58502492f744712700462b20","588279ccd63d450f00e1aa58","59e76819193831002803721e","5a6899886b88e400403c3ce5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":1,"category":{"_id":"58502492f744712700462b20","project":"556dd000d0f4740d00380dfd","__v":0,"version":"556dd000d0f4740d00380e00","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-12-13T16:40:50.101Z","from_sync":false,"order":9,"slug":"webhooks","title":"Webhooks"},"user":"550e28af11e8d00d00b803f2","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-15T15:20:32.469Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":204,"name":"","code":" ","language":"json"}]},"settings":"","examples":{"codes":[{"code":"{\n  \"applicationId\": 5,\n  \"clearingAccount\": \"1234\",\n  \"action\": \"SUBMITTED\",\n  \"email\": \"test:::at:::example.com\"\n}","name":"Example payload","language":"json"}]},"method":"post","auth":"required","params":[{"_id":"5852b4c088b5e82f0074809f","ref":"","in":"body","required":true,"desc":"An application Id","default":"","type":"int","name":"applicationId"},{"_id":"5852b4c088b5e82f0074809e","ref":"","in":"body","required":true,"desc":"A clearing account","default":"","type":"string","name":"clearingAccount"},{"_id":"5852b4c088b5e82f0074809d","ref":"","in":"body","required":true,"desc":"One of:","default":"","type":"string","name":"action"},{"_id":"5852b4c088b5e82f0074809c","ref":"","in":"body","required":true,"desc":"An email address","default":"","type":"string","name":"email"},{"_id":"5852b61488b5e82f007480a2","ref":"","in":"header","required":true,"desc":"Authorization is required for this API.  Please use a valid credentials.","default":"Basic XXX","type":"string","name":"Authorization"}],"url":"/webhooks/application"},"isReference":true,"order":4,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"This is an advisor-only API.  Restrictions may apply.\"\n}\n[/block]\nBy making a request to this endpoint, we will send a fake web hook request to all registered URLs using the parameters you send.  This allows developers to integration test web hook functionality without creating applications or ACH profiles.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Any data sent in this payload can be fake.\"\n}\n[/block]","excerpt":"Send a test application webhook for the Tradier Brokerage API","slug":"test-application-payload","type":"endpoint","title":"Test Application Hook"}

postTest Application Hook

Send a test application webhook for the Tradier Brokerage API

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

applicationId:
required
integer
An application Id
clearingAccount:
required
string
A clearing account
action:
required
string
One of:
email:
required
string
An email address

Headers

Authorization:
required
stringBasic XXX
Authorization is required for this API. Please use a valid credentials.

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "This is an advisor-only API. Restrictions may apply." } [/block] By making a request to this endpoint, we will send a fake web hook request to all registered URLs using the parameters you send. This allows developers to integration test web hook functionality without creating applications or ACH profiles. [block:callout] { "type": "info", "body": "Any data sent in this payload can be fake." } [/block]