Report Filing Service

<back to all web services

UpdateWebhookSubscriptionAsync

UpdateSubscriptionsWebhooksAsync

Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.

Requires Authentication
The following routes are available for this service:
POST/async/webhooks/subscriptions/{Id}/update
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 update a webhook subscription specified by its unique identifier.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateWebhookSubscriptionBase(IReturn[SubscriptionResponse], IPost, IConfigurable):
    """
    Specifies a request to update a webhook subscription specified by its unique identifier.
    """

    # @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")
    id: Optional[str] = None
    """
    The unique identifier of the subscriber.
    """


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


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


    # @ApiMember(Description="The callback URL to be called when an \"event\" of a certain type is going to be raised.", 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="The current secret that is used to sign and authenticate messages from webhook endpoints.", IsRequired=true, Name="CurrentSecret")
    current_secret: Optional[str] = None
    """
    The current secret that is used to sign and authenticate messages from webhook endpoints.
    """


    # @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.", Name="NewSecret")
    new_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="Indicates whether the subscription is enabled or disabled.", Name="IsActive")
    is_active: Optional[bool] = None
    """
    Indicates whether the subscription is enabled or disabled.
    """


    # @ApiMember(Description="The XML-encoded RSA public key to encrypt the new 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 new 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 SubscriptionResponse


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionConfig:
    url: Optional[str] = None
    content_type: Optional[str] = None
    secret: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebhookSubscription:
    id: Optional[str] = None
    name: Optional[str] = None
    event: Optional[str] = None
    is_active: bool = False
    created_date_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    created_by_id: Optional[str] = None
    last_modified_date_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    config: Optional[SubscriptionConfig] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionDeliveryResult:
    attempted_date_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    status_description: Optional[str] = None
    status_code: Optional[HttpStatusCode] = None
    subscription_id: Optional[str] = None
    id: Optional[str] = None
    event_id: Optional[str] = None


# @Api(Description="Represents a service response that encapsulates a webhook subscription.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionResponse:
    """
    Represents a service response that encapsulates a webhook subscription.
    """

    # @ApiMember(Description="The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key.", Name="Subscription")
    subscription: Optional[WebhookSubscription] = None
    """
    The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key.
    """


    # @ApiMember(Description="The history of the subscription event.", Name="History")
    history: Optional[List[SubscriptionDeliveryResult]] = None
    """
    The history of the subscription event.
    """


    # @ApiMember(Description="The status of the response.", Name="ResponseStatus")
    response_status: Optional[ResponseStatus] = None
    """
    The status of the response.
    """


# @Api(Description="Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateWebhookSubscriptionAsync(UpdateWebhookSubscriptionBase):
    """
    Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.
    """

    pass

Python UpdateWebhookSubscriptionAsync 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 /async/webhooks/subscriptions/{Id}/update HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateWebhookSubscriptionAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests">
  <ContentType>String</ContentType>
  <CurrentSecret>String</CurrentSecret>
  <Event>String</Event>
  <Id>String</Id>
  <IsActive>false</IsActive>
  <Name>String</Name>
  <NewSecret>String</NewSecret>
  <PublicKeyXml>String</PublicKeyXml>
  <Url>String</Url>
</UpdateWebhookSubscriptionAsync>

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

<SubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses">
  <History xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
    <d2p1:SubscriptionDeliveryResult>
      <d2p1:AttemptedDateUtc>0001-01-01T00:00:00</d2p1:AttemptedDateUtc>
      <d2p1:EventId>String</d2p1:EventId>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:StatusCode>Continue</d2p1:StatusCode>
      <d2p1:StatusDescription>String</d2p1:StatusDescription>
      <d2p1:SubscriptionId>String</d2p1:SubscriptionId>
    </d2p1:SubscriptionDeliveryResult>
  </History>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Subscription xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
    <d2p1:Config>
      <d2p1:ContentType>String</d2p1:ContentType>
      <d2p1:Secret>String</d2p1:Secret>
      <d2p1:Url>String</d2p1:Url>
    </d2p1:Config>
    <d2p1:CreatedById>String</d2p1:CreatedById>
    <d2p1:CreatedDateUtc>0001-01-01T00:00:00</d2p1:CreatedDateUtc>
    <d2p1:Event>String</d2p1:Event>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:IsActive>false</d2p1:IsActive>
    <d2p1:LastModifiedDateUtc>0001-01-01T00:00:00</d2p1:LastModifiedDateUtc>
    <d2p1:Name>String</d2p1:Name>
  </Subscription>
</SubscriptionResponse>
© 2020 - 2023 PricewaterhouseCoopers GmbH Wirtschaftsprüfungsgesellschaft.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Portions of this program may use third-party open source components governed by the respective open source license terms.