Create Subscription
post
https://api.synapsefi.com
/v3.1/subscriptions
Create Subscription
Subscription Limits Only one subscription URL can be enabled per scope. Previous subscriptions for the same scope will be overwritten. We recommend disabling subscriptions that you do not wish to use any longer to avoid confusion.
Originating IP Address We send webhooks from the originating IP address: 50.112.48.126, 44.238.232.80 or 35.85.83.81.
Go to Subscription Object Details to see all the required and optional body parameters allowed when creating a subscription.

Example Request

HTTP
Python
JavaScript
Ruby
PHP
Go
1
POST /v3.1/subscriptions HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267
4
Content-Type: application/json
5
6
{
7
"scope": [
8
"USERS|POST",
9
"USER|PATCH",
10
"NODES|POST",
11
"NODE|PATCH",
12
"TRANS|POST",
13
"TRAN|PATCH",
14
"SUBNETS|POST",
15
"SUBNET|PATCH"
16
],
17
"url": "https://requestb.in/zp216zzp"
18
}
Copied!
1
webhook_url = "https://requestb.in/zp216zzp"
2
scope = [
3
"USERS|POST",
4
"USER|PATCH",
5
"NODES|POST",
6
"NODE|PATCH",
7
"TRANS|POST",
8
"TRAN|PATCH"
9
]
10
11
subs = client.create_subscription(webhook_url, scope)
Copied!
1
const subscriptionUrl = 'https://requestb.in/zp216zzp';
2
3
client.createSubscription(subscriptionUrl);
Copied!
1
body = {
2
"scope": [
3
"USERS|POST",
4
"USER|PATCH",
5
"NODES|POST",
6
"NODE|PATCH",
7
"TRANS|POST",
8
"TRAN|PATCH"
9
],
10
"url": "https://requestb.in/zp216zzp"
11
}
12
13
client.create_subscriptions(scope: body)
Copied!
1
$body = (object) [
2
scope" => [
3
"USERS|POST",
4
"USER|PATCH",
5
"NODES|POST",
6
"NODE|PATCH",
7
"TRANS|POST",
8
"TRAN|PATCH"
9
],
10
'url' => 'https://requestb.in/zp216zzp'
11
];
12
13
$client->create_subscription( $body );
Copied!
1
body := `{
2
"scope": [
3
"USERS|POST",
4
"USER|PATCH",
5
"NODES|POST",
6
"NODE|PATCH",
7
"TRANS|POST",
8
"TRAN|PATCH"
9
],
10
"url": "https://requestb.in/zp216zzp"
11
}`
12
13
data, err := client.CreateSubscription(body)
Copied!
Last modified 1mo ago
Export as PDF
Copy link