v1

latestOpenAPI 3.0.22026-07-1351821.6 KB
Subscribe to notifications

List existing subscriptions.

get/v1/subscriptions

Query parameters

taskTypestring

The task type of the subscription(s) to be returned.

The task type of the subscription(s) to be returned.

taskSubTypestring

Task sub type of the subscriptions(s) to be returned.

Task sub type of the subscriptions(s) to be returned.

lastUpdatedstring

Date Filter. Returns items that have been updated after specified date.

Date Filter. Returns items that have been updated after specified date.

Response

Successful Response

Example response

{
  "subscriptions": [
    {
      "taskType": "AccountingDocuments",
      "taskSubType": "All",
      "notificationWebhookURL": "https://bwnotificationapi.customer.com/accountingdocumentnotifications",
      "webhookAuthenticationToken": "ad65rujltr9093ijhdkutiyua09döijhsa76d8799w8pqugdfafjdhfkjhadls",
      "lastUpdated": "2021-08-04T08:39:13Z",
      "autoResponder": {
        "autoResponseMessage": "Updated coding details.",
        "fieldUpdateArray": [
          {
            "fieldId": "codingRows[2]/accountCode",
            "updateToValue": "02600"
          }
        ]
      }
    }
  ]
}
All 5 operations