<back to all web services

CreateWebhookSubscriptions

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

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Specifies a request to create webhook subscriptions from a user tax number, account ID and webhook events.
*/
// @Api(Description="Specifies a request to create webhook subscriptions from a user tax number, account ID and webhook events.")
abstract class CreateWebhookSubscriptionsBase implements IPost, IConfigurable
{
    /**
    * The name of the subscription.
    */
    // @ApiMember(Description="The name of the subscription.", Name="Name")
    String? name;

    /**
    * 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 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")
    String? authSteuernummer;

    /**
    * The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
    */
    // @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")
    String? accountId;

    /**
    * The names of the subscribed events. .A subscriber can subscribe to more than one event.
    */
    // @ApiMember(Description="The names of the subscribed events. .A subscriber can subscribe to more than one event.", IsRequired=true, Name="Events")
    List<String>? events;

    /**
    * The callback URL to be called when an "event" of a certain type is going to be raised.
    */
    // @ApiMember(Description="The callback URL to be called when an \"event\" of a certain type is going to be raised.", IsRequired=true, Name="Url")
    String? url;

    /**
    * The MIME type of content pushed to the recipient service e.g. application/json
    */
    // @ApiMember(Description="The MIME type of content pushed to the recipient service e.g. application/json", Name="ContentType")
    String? contentType;

    /**
    * 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="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")
    String? secret;

    /**
    * 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.
    */
    // @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")
    String? publicKeyXml;

    CreateWebhookSubscriptionsBase({this.name,this.authSteuernummer,this.accountId,this.events,this.url,this.contentType,this.secret,this.publicKeyXml});
    CreateWebhookSubscriptionsBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        authSteuernummer = json['authSteuernummer'];
        accountId = json['accountId'];
        events = JsonConverters.fromJson(json['events'],'List<String>',context!);
        url = json['url'];
        contentType = json['contentType'];
        secret = json['secret'];
        publicKeyXml = json['publicKeyXml'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'authSteuernummer': authSteuernummer,
        'accountId': accountId,
        'events': JsonConverters.toJson(events,'List<String>',context!),
        'url': url,
        'contentType': contentType,
        'secret': secret,
        'publicKeyXml': publicKeyXml
    };

    getTypeName() => "CreateWebhookSubscriptionsBase";
    TypeContext? context = _ctx;
}

/**
* Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events.
*/
// @Api(Description="Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events.")
class CreateWebhookSubscriptions extends CreateWebhookSubscriptionsBase implements IConvertible
{
    CreateWebhookSubscriptions();
    CreateWebhookSubscriptions.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "CreateWebhookSubscriptions";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
    'CreateWebhookSubscriptionsBase': TypeInfo(TypeOf.AbstractClass),
    'CreateWebhookSubscriptions': TypeInfo(TypeOf.Class, create:() => CreateWebhookSubscriptions()),
});

Dart CreateWebhookSubscriptions DTOs

POST /sync/webhooks/subscriptions/create HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/json
Content-Type: application/json
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/json
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"}}}]