<back to all web services

UpdateWebhookSubscriptionAsync

Represents a request to update a webhook subscription specified by its unique identifier 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 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

POST /async/webhooks/subscriptions/{Id}/update HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","name":"String","event":"String","url":"String","contentType":"String","currentSecret":"String","newSecret":"String","isActive":false,"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"}}}