<back to all web services

CreateWebhookSubscriptions

Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events.

namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Specifies a request to create webhook subscriptions from a user tax number, account ID and webhook events.
    ///</summary>
    [<Api(Description="Specifies a request to create webhook subscriptions from a user tax number, account ID and webhook events.")>]
    [<AllowNullLiteral>]
    type CreateWebhookSubscriptionsBase() = 
        interface IPost
        ///<summary>
        ///The name of the subscription.
        ///</summary>
        [<ApiMember(Description="The name of the subscription.", Name="Name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
        ///</summary>
        [<ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer")>]
        member val AuthSteuernummer:String = null with get,set

        ///<summary>
        ///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
        ///</summary>
        [<ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")>]
        member val AccountId:String = null with get,set

        ///<summary>
        ///The names of the subscribed events. .A subscriber can subscribe to more than one event.
        ///</summary>
        [<ApiMember(Description="The names of the subscribed events. .A subscriber can subscribe to more than one event.", IsRequired=true, Name="Events")>]
        member val Events:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///The callback URL to be called when an "event" of a certain type is going to be raised.
        ///</summary>
        [<ApiMember(Description="The callback URL to be called when an \"event\" of a certain type is going to be raised.", IsRequired=true, Name="Url")>]
        member val Url:String = null with get,set

        ///<summary>
        ///The MIME type of content pushed to the recipient service e.g. application/json
        ///</summary>
        [<ApiMember(Description="The MIME type of content pushed to the recipient service e.g. application/json", Name="ContentType")>]
        member val ContentType:String = null with get,set

        ///<summary>
        ///A random Base64-encoded secret key (8 or more characters) to sign and authenticate messages from webhook endpoints. .When receiving a webhook event in your subscribers service, calculate the HMAC signature of the request body using this secret. Compare the calculated signature with the signature included in the "X-Hub-Signature" header of the web hook event. If the signatures do not match, then disregard it, and don't process the request any further.
        ///</summary>
        [<ApiMember(Description="A random Base64-encoded secret key (8 or more characters) to sign and authenticate messages from webhook endpoints. .When receiving a webhook event in your subscribers service, calculate the HMAC signature of the request body using this secret. Compare the calculated signature with the signature included in the \"X-Hub-Signature\" header of the web hook event. If the signatures do not match, then disregard it, and don't process the request any further.", IsRequired=true, Name="Secret")>]
        member val Secret:String = null with get,set

        ///<summary>
        ///The XML-encoded RSA public key to encrypt the secret of the webhook subscription. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted secret with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding.
        ///</summary>
        [<ApiMember(Description="The XML-encoded RSA public key to encrypt the secret of the webhook subscription. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted secret with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding.", IsRequired=true, Name="PublicKeyXml")>]
        member val PublicKeyXml:String = null with get,set

    ///<summary>
    ///Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events.
    ///</summary>
    [<Api(Description="Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events.")>]
    [<AllowNullLiteral>]
    type CreateWebhookSubscriptions() = 
        inherit CreateWebhookSubscriptionsBase()

F# CreateWebhookSubscriptions DTOs

POST /sync/webhooks/subscriptions/create HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	name: String,
	authSteuernummer: String,
	accountId: String,
	events: 
	[
		String
	],
	url: String,
	contentType: String,
	secret: String,
	publicKeyXml: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		subscription: 
		{
			id: String,
			name: String,
			event: String,
			isActive: False,
			createdDateUtc: 0001-01-01,
			createdById: String,
			lastModifiedDateUtc: 0001-01-01,
			config: 
			{
				url: String,
				contentType: String,
				secret: String
			}
		},
		history: 
		[
			{
				attemptedDateUtc: 0001-01-01,
				statusDescription: String,
				statusCode: Continue,
				subscriptionId: String,
				id: String,
				eventId: String
			}
		],
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		}
	}
]