Report Filing Service

CreateWebhookSubscriptions

CreateSubscriptionsWebhooksSync

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

The following routes are available for this service:
POST	/sync/webhooks/subscriptions/create

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Specifies a request to create webhook subscriptions from a user tax number, account ID and webhook events.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateWebhookSubscriptionsBase(IReturn[List[SubscriptionResponse]], IPost, IConfigurable):
    """
    Specifies a request to create webhook subscriptions from a user tax number, account ID and webhook events.
    """

    # @ApiMember(Description="The name of the subscription.", Name="Name")
    name: Optional[str] = None
    """
    The name of the subscription.
    """


    # @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")
    auth_steuernummer: Optional[str] = None
    """
    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"
    """


    # @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")
    account_id: Optional[str] = None
    """
    The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
    """


    # @ApiMember(Description="The names of the subscribed events. .A subscriber can subscribe to more than one event.", IsRequired=true, Name="Events")
    events: Optional[List[str]] = None
    """
    The names of the subscribed events. .A subscriber can subscribe to more than one event.
    """


    # @ApiMember(Description="The callback URL to be called when an \"event\" of a certain type is going to be raised.", IsRequired=true, Name="Url")
    url: Optional[str] = None
    """
    The callback URL to be called when an "event" of a certain type is going to be raised.
    """


    # @ApiMember(Description="The MIME type of content pushed to the recipient service e.g. application/json", Name="ContentType")
    content_type: Optional[str] = None
    """
    The MIME type of content pushed to the recipient service e.g. application/json
    """


    # @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")
    secret: Optional[str] = None
    """
    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.
    """


    # @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")
    public_key_xml: Optional[str] = None
    """
    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.
    """
    @staticmethod
    def response_type(): return List[SubscriptionResponse]


# @Api(Description="Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateWebhookSubscriptions(CreateWebhookSubscriptionsBase):
    """
    Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events.
    """

    pass

Python CreateWebhookSubscriptions DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

<CreateWebhookSubscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests">
  <AccountId>String</AccountId>
  <AuthSteuernummer>String</AuthSteuernummer>
  <ContentType>String</ContentType>
  <Events xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Events>
  <Name>String</Name>
  <PublicKeyXml>String</PublicKeyXml>
  <Secret>String</Secret>
  <Url>String</Url>
</CreateWebhookSubscriptions>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses">
  <SubscriptionResponse>
    <History xmlns:d3p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
      <d3p1:SubscriptionDeliveryResult>
        <d3p1:AttemptedDateUtc>0001-01-01T00:00:00</d3p1:AttemptedDateUtc>
        <d3p1:EventId>String</d3p1:EventId>
        <d3p1:Id>String</d3p1:Id>
        <d3p1:StatusCode>Continue</d3p1:StatusCode>
        <d3p1:StatusDescription>String</d3p1:StatusDescription>
        <d3p1:SubscriptionId>String</d3p1:SubscriptionId>
      </d3p1:SubscriptionDeliveryResult>
    </History>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <Subscription xmlns:d3p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
      <d3p1:Config>
        <d3p1:ContentType>String</d3p1:ContentType>
        <d3p1:Secret>String</d3p1:Secret>
        <d3p1:Url>String</d3p1:Url>
      </d3p1:Config>
      <d3p1:CreatedById>String</d3p1:CreatedById>
      <d3p1:CreatedDateUtc>0001-01-01T00:00:00</d3p1:CreatedDateUtc>
      <d3p1:Event>String</d3p1:Event>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:IsActive>false</d3p1:IsActive>
      <d3p1:LastModifiedDateUtc>0001-01-01T00:00:00</d3p1:LastModifiedDateUtc>
      <d3p1:Name>String</d3p1:Name>
    </Subscription>
  </SubscriptionResponse>
</ArrayOfSubscriptionResponse>