<back to all web services

UpdateWebhookSubscriptionAsync

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

import Foundation
import ServiceStack

/**
* Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.
*/
// @Api(Description="Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.")
public class UpdateWebhookSubscriptionAsync : UpdateWebhookSubscriptionBase
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

/**
* Specifies a request to update a webhook subscription specified by its unique identifier.
*/
// @Api(Description="Specifies a request to update a webhook subscription specified by its unique identifier.")
public class UpdateWebhookSubscriptionBase : IPost, IConfigurable, Codable
{
    /**
    * The unique identifier of the subscriber.
    */
    // @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")
    public var id:String

    /**
    * The name of the subscription.
    */
    // @ApiMember(Description="The name of the subscription.", Name="Name")
    public var name:String

    /**
    * The name of the subscribed event.
    */
    // @ApiMember(Description="The name of the subscribed event.", Name="Event")
    public var event:String

    /**
    * 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.", Name="Url")
    public var url:String

    /**
    * 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 var contentType:String

    /**
    * The current secret that is used to sign and authenticate messages from webhook endpoints.
    */
    // @ApiMember(Description="The current secret that is used to sign and authenticate messages from webhook endpoints.", IsRequired=true, Name="CurrentSecret")
    public var currentSecret:String

    /**
    * 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.", Name="NewSecret")
    public var newSecret:String

    /**
    * Indicates whether the subscription is enabled or disabled.
    */
    // @ApiMember(Description="Indicates whether the subscription is enabled or disabled.", Name="IsActive")
    public var isActive:Bool?

    /**
    * 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.
    */
    // @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 var publicKeyXml:String

    required public init(){}
}

/**
* Represents a service response that encapsulates a webhook subscription.
*/
// @Api(Description="Represents a service response that encapsulates a webhook subscription.")
public class SubscriptionResponse : Codable
{
    /**
    * 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 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")
    public var subscription:WebhookSubscription

    /**
    * The history of the subscription event.
    */
    // @ApiMember(Description="The history of the subscription event.", Name="History")
    public var history:[SubscriptionDeliveryResult] = []

    /**
    * The status of the response.
    */
    // @ApiMember(Description="The status of the response.", Name="ResponseStatus")
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class WebhookSubscription : Codable
{
    public var id:String
    public var name:String
    public var event:String
    public var isActive:Bool
    public var createdDateUtc:Date
    public var createdById:String
    public var lastModifiedDateUtc:Date
    public var config:SubscriptionConfig

    required public init(){}
}

public class SubscriptionConfig : Codable
{
    public var url:String
    public var contentType:String
    public var secret:String

    required public init(){}
}

public class SubscriptionDeliveryResult : Codable
{
    public var attemptedDateUtc:Date
    public var statusDescription:String
    public var statusCode:HttpStatusCode
    public var subscriptionId:String
    public var id:String
    public var eventId:String

    required public init(){}
}

Swift 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"}}}