Merge pull request #531 from SparkPost/SAA-715

SAA-715 update docs for subaccount update and exception_subaccounts

Author: GabrielSoga

content/api/webhooks.apib

@@ -30,6 +30,7 @@ You can receive any of the following types of events in webhook payloads.
     + events (array)  - Array of event types this webhook will send. Use the [Events Documentation](#webhooks-documentation) endpoint to list the available event types.
     + active (boolean) - The status of the webhook. When false, the target will no longer receive batches.
     + custom_headers (object) - Object of custom headers to be used during POST requests to target.
+    + exception_subaccounts (array) - Array of subaccount numbers to prevent receiving events in your webhook (only available for webhooks with Primary and All Subaccounts event source).
     + auth_type (enum) - Type of authentication to be used during POST requests to target. Read more about [webhook authentication](https://www.sparkpost.com/docs/tech-resources/webhook-authentication/#webhook-authentication-set-up).
         + none
         + basic
@@ -50,6 +51,7 @@ You can receive any of the following types of events in webhook payloads.
         "target": "http://client.example.com/example-webhook",
         "events": ["delivery", "injection", "open", "click"],
         "active": true,
+        "exception_subaccounts": [123],
         "custom_headers": {
             "x-api-key": "abcd"
         },
@@ -80,6 +82,7 @@ Webhooks only support standard ports, port 80 for HTTP traffic and port 443 for
     + active (boolean) - The status of the webhook. When false, the target will no longer receive batches.
         + Default: true
     + custom_headers (object) - Object of custom headers to be used during POST requests to target.
+    + exception_subaccounts (array) - Array of subaccount numbers to prevent receiving events in your webhook (only available for webhooks with Primary and All Subaccounts event source). Must not have duplicate values nor be empty. Integer values only. Max size: 10.
     + auth_type: none, basic, oauth2 (enum)
         Type of authentication to be used during POST requests to target. Read more about [webhook authentication](https://www.sparkpost.com/docs/tech-resources/webhook-authentication/#webhook-authentication-set-up).
         + Default: none
@@ -114,6 +117,7 @@ Webhooks only support standard ports, port 80 for HTTP traffic and port 443 for
                         "grant_type": "client_credentials"
                     }
                 },
+                "exception_subaccounts": [123],
                 "events": [
                     "delivery",
                     "injection",
@@ -232,6 +236,7 @@ and returns information on the response received from the target.
                     "open",
                     "click"
                 ],
+                "exception_subaccounts": ["123"],
                 "auth_type": "oauth2",
                 "auth_request_details": {
                     "url": "https://oauth.myurl.com/tokens",
@@ -322,6 +327,8 @@ When SparkPost does not get a 200 response from your webhook consumer endpoint t
     + events (array)  - Array of event types this webhook will send. Use the [Events Documentation](#webhooks-documentation) endpoint to list the available event types.
     + active (boolean) - The status of the webhook. When false, the target will no longer receive batches.
     + custom_headers (object) - Object of custom headers to be used during POST requests to target.
+    + exception_subaccounts (array) - Array of subaccount numbers to prevent receiving events in your webhook (only available for webhooks with Primary and All Subaccounts event source). Must not have duplicate values. Integers or empty array. New array values will completely replace the current values. Max size: 10.
+    + subaccount_id (number) - The new Subaccount to be set as the Event Source. Can be any integer number (use -1 for Primary and All Subaccounts or 0 for Primary Account only).
     + auth_type: none, basic, oauth2 (enum)
         Type of authentication to be used during POST requests to target. Read more about [webhook authentication](https://www.sparkpost.com/docs/tech-resources/webhook-authentication/#webhook-authentication-set-up).
     + auth_request_details (object) - Object containing details needed to request authorization token for OAuth 2.0. This is required when `auth_type` is oauth2.
@@ -352,6 +359,7 @@ Any batches already queued for delivery to this webhook will not be affected. Fo
                     "generation_rejection",
                     "delay"
                 ],
+                "subaccount_id": 123,
                 "auth_type": "none",
                 "custom_headers": {
                     "x-api-key": "abcd"