POST example/api/WebHookSubscription

https://app.bwz.se/bedrock/example/api/WebHookSubscription

Creates a WebHookSubscriptionModel.

Request Information

URI Parameters

None.

Body Parameters

Are the headers visible externally

Name	Description	Type	Additional information
AppId	The AppId for the receiving application.	string	Data type: Text Valid name with max 256 characters
Name	A name for the subscription.	string	Required Min length: 1 Valid name with max 256 characters
Uri	The uri to the receiving application.	string	Required Max length: 2083
DefaultHeaders	Default headers that are required by the receiving application. Leave empty if no extra headers are required.	Dictionary of string [key] and Collection of string [value]	None.
WebHookSubscriptionPackageNames	Selected webhook packages names determining witch events to subscribe on.	Collection of string	None.
Secret	The key for the receiving application. Use as a shared secret.	string	Data type: Text Valid name with max 256 characters
BatchWebhooks	Determines if the webhooks should be sent in batches	boolean	None.
BatchSize	The amount of webhooks to be sent in each batch	string	None.
HideHeaderData	Are the headers visible externally	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "AppId": "sample string 1",
  "Name": "sample string 2",
  "Uri": "sample string 3",
  "DefaultHeaders": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "WebHookSubscriptionPackageNames": [
    "sample string 1",
    "sample string 2"
  ],
  "Secret": "sample string 4",
  "BatchWebhooks": true,
  "BatchSize": "sample string 5",
  "HideHeaderData": true
}

application/xml, text/xml

Sample:

<WebHookSubscriptionCreateArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.WebHookSubscription">
  <AppId>sample string 1</AppId>
  <BatchSize>sample string 5</BatchSize>
  <BatchWebhooks>true</BatchWebhooks>
  <DefaultHeaders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </DefaultHeaders>
  <HideHeaderData>true</HideHeaderData>
  <Name>sample string 2</Name>
  <Secret>sample string 4</Secret>
  <Uri>sample string 3</Uri>
  <WebHookSubscriptionPackageNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WebHookSubscriptionPackageNames>
</WebHookSubscriptionCreateArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WebHookSubscriptionModel

Name	Description	Type	Additional information
Id	Id of the WebHookSubscription.	integer	None.
Name	Name of the WebHookSubscription.	string	None.
WebHookSubscriptionPackages	The subscribed webhook event packages.	Dictionary of integer [key] and string [value]	None.
Uri	The uri to the receiving application.	string	None.
DefaultHeaders	Default headers that are required by the receiving application.	Dictionary of string [key] and Collection of string [value]	None.
IsActive	Determines if the subscription is in use or not.	boolean	None.
AppId	The AppId for the receiving application.	string	None.
Secret	The key for the receiving application. Use as a shared secret.	string	None.
BatchWebhooks	Determines if the webhooks should be sent in batches	boolean	None.
BatchSize	The amount of webhooks to be sent in each batch	integer	None.
HideHeaderData	Are the headers visible externally	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "WebHookSubscriptionPackages": {
    "1": "sample string 2",
    "3": "sample string 4"
  },
  "Uri": "sample string 3",
  "DefaultHeaders": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "IsActive": true,
  "AppId": "sample string 5",
  "Secret": "sample string 6",
  "BatchWebhooks": true,
  "BatchSize": 8,
  "HideHeaderData": true
}

application/xml, text/xml

Sample:

<WebHookSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.WebHookSubscription">
  <AppId>sample string 5</AppId>
  <BatchSize>8</BatchSize>
  <BatchWebhooks>true</BatchWebhooks>
  <DefaultHeaders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </DefaultHeaders>
  <HideHeaderData>true</HideHeaderData>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <Name>sample string 2</Name>
  <Secret>sample string 6</Secret>
  <Uri>sample string 3</Uri>
  <WebHookSubscriptionPackages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfintstring>
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfintstring>
  </WebHookSubscriptionPackages>
</WebHookSubscriptionModel>