<back to all web services

CreateWebhookSubscriptionsAsync

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

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 in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateWebhookSubscriptionsAsync(CreateWebhookSubscriptionsBase):
    """
    Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events in an asynchronous operation.
    """

    pass

Python CreateWebhookSubscriptionsAsync DTOs

POST /async/webhooks/subscriptions/create HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
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: application/x-msgpack
Content-Length: length

[{"subscription":{"id":"String","name":"String","event":"String","isActive":false,"createdDateUtc":"\/Date(-62135596800000-0000)\/","createdById":"String","lastModifiedDateUtc":"\/Date(-62135596800000-0000)\/","config":{"url":"String","contentType":"String","secret":"String"}},"history":[{"attemptedDateUtc":"\/Date(-62135596800000-0000)\/","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"}}}]