{"_id":"59f79e3c584eb200345cebba","parentDoc":null,"project":"59f79e3c584eb200345ceafc","__v":0,"category":{"_id":"59f79e3c584eb200345ceb3f","__v":0,"project":"59f79e3c584eb200345ceafc","version":"59f79e3c584eb200345ceaff","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-07T15:26:56.680Z","from_sync":false,"order":8,"slug":"subscriptions","title":"Subscriptions"},"version":{"_id":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":3,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["59f79e3c584eb200345ceb3a","59f79e3c584eb200345ceb3b","59f79e3c584eb200345ceb3c","59f79e3c584eb200345ceb3d","59f79e3c584eb200345ceb3e","59f79e3c584eb200345ceb3f","59f79e3c584eb200345ceb45","59f79e3c584eb200345ceb46","59f79e3c584eb200345ceb48","59f79e3c584eb200345ceb49","5aa21b60c0bda0002d1568b6","5afb6888212c690003ae3d3b","5b4bdcd3737d1800031d2293"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.1.0","version":"3.1"},"user":"54e4044e8ef7552300409dcb","githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-07T15:57:44.495Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"POST /v3.1/subscriptions HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\nContent-Type: application/json\n\n{\n  \"scope\": [\n    \"USERS|POST\",\n    \"USER|PATCH\",\n    \"NODES|POST\",\n    \"NODE|PATCH\",\n    \"TRANS|POST\",\n    \"TRAN|PATCH\"\n  ],\n  \"url\": \"https://requestb.in/zp216zzp\"\n}","language":"http"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n    \"_id\": \"589b6adec83e17002122196c\",\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://uat-api.synapsefi.com/v3.1/subscriptions/589b6adec83e17002122196c\"\n        }\n    },\n    \"_v\": 2,\n    \"client_id\": \"589acd9ecb3cd400fa75ac06\",\n    \"is_active\": true,\n    \"scope\": [\n        \"USERS|POST\",\n        \"USER|PATCH\",\n        \"NODES|POST\",\n        \"NODE|PATCH\",\n        \"TRANS|POST\",\n        \"TRAN|PATCH\"\n    ],\n    \"url\": \"https://requestb.in/zp216zzp\"\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"body","required":true,"desc":"Webhook URL","default":"","type":"string","name":"url"},{"_id":"55fa4d6f764f5021009506c9","ref":"","in":"body","required":true,"desc":"Scope of the subscription","default":"","type":"array_string","name":"scope"}],"url":"/v3.1/subscriptions"},"isReference":true,"order":3,"body":"","excerpt":"","slug":"create-subscription","type":"endpoint","title":"Create Subscription"}

postCreate Subscription


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

url:
required
string
Webhook URL
scope:
required
array of strings
Scope of the subscription

Examples


Result Format