Get Subscription

GET 
/webhooks/:subscriptionId

Returns a specified subscription by subscriptionId

Request

Path Parameters

subscriptionId stringrequired

The subscription id

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

subscription

object

address string

topic string[]

isEnabled boolean

Default value: true

subscriptionId string

Example (from schema)

{
  "subscription": {
    "address": "https://your-server.com/api/v1/webhhook",
    "topic": [
      "connection/created"
    ],
    "isEnabled": false,
    "subscriptionId": "658a0e6071defce8902069de"
  }
}

Result

{
    "subscription": {
        "address": "https://your-server.com/api/v1/webhhook",
            "topic": [
                "connection/created",
                "connection/deleted",
                "connection/authentication_failure",
                "commerce/customers",
                "commerce/orders",
                "commerce/products",
                "accounting/companyInfo",
                "accounting/accounts",
                "accounting/customers",
                "accounting/taxRates",
                "accounting/trackingCategories",
                "accounting/vendors",
                "accounting/items",
                "accounting/payments",
                "accounting/purchaseOrders",
                "accounting/bills",
                "accounting/invoices",
                "crm/accounts",
                "crm/contacts",
                "crm/leads",
                "crm/notes",
                "crm/opportunities",
                "crm/stages",
                "crm/tasks",
                "crm/users",
                "sync/started",
                "sync/completed",
                "sync/failed"
            ],
            "isEnabled": false,
            "subscriptionId": "658a0e6071defce8902069de"
    }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...