Create Subscription

Create Subscription

POST https://api.synapsefi.com/v3.1/subscriptions

This endpoint allows you to create a subscription to stay updated on the status of users, nodes, transactions & subnets.

Headers

Name	Type	Description
Content-Type	string	This value should be application/json
X-SP-GATEWAY	string	Your Client ID & Secret, separated by a pipe

Request Body

Name	Type	Description
scope	array	Scope of subscription.
url	string	URL destination for webhooks

200 Subscription successfully created.

{
  "_id": "589b6adec83e17002122196c",
  "_links": {
    "self": {
      "href": "https://uat-api.synapsefi.com/v3.1/subscriptions/589b6adec83e17002122196c"
    }
  },
  "_v": 2,
  "client_id": "589acd9ecb3cd400fa75ac06",
  "is_active": true,
  "scope": [
    "USERS|POST",
    "USER|PATCH",
    "NODES|POST",
    "NODE|PATCH",
    "TRANS|POST",
    "TRAN|PATCH",
    "SUBNETS|POST",
    "SUBNET|PATCH"
  ],
  "url": "https://requestb.in/zp216zzp"
}

400 Could not 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

POST /v3.1/subscriptions HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267
Content-Type: application/json

{
  "scope": [
    "USERS|POST",
    "USER|PATCH",
    "NODES|POST",
    "NODE|PATCH",
    "TRANS|POST",
    "TRAN|PATCH",
    "SUBNETS|POST",
    "SUBNET|PATCH"
  ],
  "url": "https://requestb.in/zp216zzp"
}

Python

webhook_url = "https://requestb.in/zp216zzp"
scope =  [
  "USERS|POST",
  "USER|PATCH",
  "NODES|POST",
  "NODE|PATCH",
  "TRANS|POST",
  "TRAN|PATCH"
]

subs = client.create_subscription(webhook_url, scope)

JavaScript

const subscriptionUrl = 'https://requestb.in/zp216zzp';

client.createSubscription(subscriptionUrl);

Ruby

body = {
  "scope": [
    "USERS|POST",
    "USER|PATCH",
    "NODES|POST",
    "NODE|PATCH",
    "TRANS|POST",
    "TRAN|PATCH"
  ],
  "url": "https://requestb.in/zp216zzp"
}

client.create_subscriptions(scope: body)

PHP

$body = (object) [
     scope" => [
       "USERS|POST",
       "USER|PATCH",
       "NODES|POST",
       "NODE|PATCH",
       "TRANS|POST",
       "TRAN|PATCH"
     ],
      'url' => 'https://requestb.in/zp216zzp'
];

$client->create_subscription( $body );

Go

body := `{
  "scope": [
    "USERS|POST",
    "USER|PATCH",
    "NODES|POST",
    "NODE|PATCH",
    "TRANS|POST",
    "TRAN|PATCH"
  ],
  "url": "https://requestb.in/zp216zzp"
}`

data, err := client.CreateSubscription(body)