{"_id":"55ea2a3c0b48a121002ab404","user":"55dd080d0efd5821000d53b3","category":{"_id":"55e4e0ee3325e60d007fbeea","project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","pages":["55ea2a3c0b48a121002ab404","55ea2a66ba33bc3500b28ce0","563a7d21a19edf0d009723a3"],"__v":3,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-31T23:19:10.911Z","from_sync":false,"order":20,"slug":"events","title":"Events"},"githubsync":"","parentDoc":null,"version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"__v":8,"project":"55dd0853d2d97337001800e2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-04T23:33:16.163Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"method":"get","results":{"codes":[{"code":"","language":"text"}]},"auth":"required","params":[],"url":"/events/:id"},"isReference":true,"order":1,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"After receiving a webhook event\",\n  \"body\": \"We recommend retrieving an event from this endpoint after receiving a webhook event to verify the authenticity of the webhook event.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c00941648eae30\\\",\\n  \\\"Accept\\\": \\\"application/json\\\",\\n  \\\"Content-Type\\\": \\\"application/json\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Header\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{ }\",\n      \"language\": \"json\",\n      \"name\": \"Request\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"f031b865909242e098fcdc50\\\",\\n  \\\"object\\\": \\\"event\\\",\\n  \\\"resource\\\": {\\n    \\\"object\\\":\\\"payment\\\",\\n    \\\"id\\\":\\\"h3qo5rine8itrr43wfen2356\\\",\\n    \\\"amount\\\": \\\"20.37\\\",\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"description\\\": \\\"Public card payment\\\",\\n    \\\"meta\\\": {..},\\n    \\\"billingAddress\\\": {..},\\n    \\\"personalContact\\\": {..},\\n    \\\"sourceId\\\": \\\"crjeild6qpfse3a09vhtxw\\\",\\n    \\\"sourceType\\\": \\\"Card\\\",\\n    \\\"status\\\": \\\"paid\\\",\\n    \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n    \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n    },    \\n  \\\"diff\\\": {\\n    \\\"previous\\\": {\\n      \\\"status\\\": \\\"posted\\\"\\n    },\\n    \\\"changes\\\": {\\n      \\\"status\\\": \\\"paid\\\"\\n    }\\n  },\\n  \\\"urls\\\": [\\n    \\\"http://test.company.com/webhooks\\\"\\n  ],\\n  \\\"created\\\": \\\"2015-10-28T22:55:09.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2015-10-28T22:55:13.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"retrieve-event","type":"endpoint","title":"Retrieve an event"}

getRetrieve an event


Definition

{{ api_url }}{{ page_api_url }}

Documentation

[block:callout] { "type": "success", "title": "After receiving a webhook event", "body": "We recommend retrieving an event from this endpoint after receiving a webhook event to verify the authenticity of the webhook event." } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfzWp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c00941648eae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "Header" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{ }", "language": "json", "name": "Request" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"f031b865909242e098fcdc50\",\n \"object\": \"event\",\n \"resource\": {\n \"object\":\"payment\",\n \"id\":\"h3qo5rine8itrr43wfen2356\",\n \"amount\": \"20.37\",\n \"currency\": \"USD\",\n \"description\": \"Public card payment\",\n \"meta\": {..},\n \"billingAddress\": {..},\n \"personalContact\": {..},\n \"sourceId\": \"crjeild6qpfse3a09vhtxw\",\n \"sourceType\": \"Card\",\n \"status\": \"paid\",\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n }, \n \"diff\": {\n \"previous\": {\n \"status\": \"posted\"\n },\n \"changes\": {\n \"status\": \"paid\"\n }\n },\n \"urls\": [\n \"http://test.company.com/webhooks\"\n ],\n \"created\": \"2015-10-28T22:55:09.000Z\",\n \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]