post https://uat-api.synapsefi.com/v3.1/subscriptions
Request Body
| Key | Type | Description |
|---|---|---|
| url | string | [Required] URL destination for webhooks |
| scope | array of string | Scope of the subscription |
Scope Syntax
Subscription Limits
Only one subscription can be enabled for each scope. So if you have multiple subscription objects, we recommend disabling subscriptions that you do not wish to use any longer.
Originating IP Address
We will send webhooks from
50.112.48.126
| Scope‌‌ ‌‌  ‌‌  ‌‌  ‌‌  ‌‌  ‌‌  ‌‌  ‌‌  ‌‌  ‌‌ | Effect |
|---|---|
NODES|POST | Whenever a node is created with your gateway credentials, you will receive a webhook |
NODE|PATCH | Whenever a node is updated with your gateway credentials, you will receive a webhook |
USERS|POST | Whenever a user is created with your gateway, you will receive a webhook |
USER|PATCH | Whenever a user in your platform is updated, you will receive a webhook |
TRANS|POST | Whenever a transaction is created within your gateway credentials, you will receive a webhook |
TRANS|POST|JIT | Whenever a transaction is created within your gateway credentials that requires Transaction Decisioning, you will receive a webhook. |
TRAN|PATCH | Whenever a transaction is updated with your gateway credentials, you will receive a webhook |
SUBNETS|POST | Whenever a subnet is created with your gateway credentials, you will receive a webhook |
SUBNET|PATCH | Whenever a subnet is updated with your gateway credentials, you will receive a webhook |
Testing Webhooks
In order to ensure delivery of your webhooks, we recommend testing the webhook integration. Tools like Webhook Site are helpful when testing webhooks.