Report Filing Service
| POST | /async/webhooks/subscriptions/create |
|---|
/** @description 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.")
export class CreateWebhookSubscriptionsBase implements IPost, IConfigurable
{
/** @description The name of the subscription. */
// @ApiMember(Description="The name of the subscription.", Name="Name")
public name: string;
/** @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" */
// @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")
public authSteuernummer: string;
/** @description 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")
public accountId: string;
/** @description 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")
public events: string[];
/** @description 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")
public url: string;
/** @description 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")
public contentType: string;
/** @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. */
// @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")
public secret: string;
/** @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. */
// @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 publicKeyXml: string;
public constructor(init?: Partial<CreateWebhookSubscriptionsBase>) { (Object as any).assign(this, init); }
}
/** @description Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events in an asynchronous operation. */
// @Api(Description="Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events in an asynchronous operation.")
export class CreateWebhookSubscriptionsAsync extends CreateWebhookSubscriptionsBase
{
public constructor(init?: Partial<CreateWebhookSubscriptionsAsync>) { super(init); (Object as any).assign(this, init); }
}
TypeScript CreateWebhookSubscriptionsAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/webhooks/subscriptions/create HTTP/1.1
Host: reportfiling.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"}}}]