POST | /async/webhooks/subscriptions/{Id}/update |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* 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.")
open class UpdateWebhookSubscriptionAsync : UpdateWebhookSubscriptionBase()
{
}
/**
* 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.")
open class UpdateWebhookSubscriptionBase : IPost, IConfigurable
{
/**
* The unique identifier of the subscriber.
*/
@ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")
var id:String? = null
/**
* The name of the subscription.
*/
@ApiMember(Description="The name of the subscription.", Name="Name")
var name:String? = null
/**
* The name of the subscribed event.
*/
@ApiMember(Description="The name of the subscribed event.", Name="Event")
var event:String? = null
/**
* 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")
var url:String? = null
/**
* 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")
var contentType:String? = null
/**
* 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")
var currentSecret:String? = null
/**
* 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")
var newSecret:String? = null
/**
* Indicates whether the subscription is enabled or disabled.
*/
@ApiMember(Description="Indicates whether the subscription is enabled or disabled.", Name="IsActive")
var isActive:Boolean? = null
/**
* 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")
var publicKeyXml:String? = null
}
/**
* Represents a service response that encapsulates a webhook subscription.
*/
@Api(Description="Represents a service response that encapsulates a webhook subscription.")
open class SubscriptionResponse
{
/**
* 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")
var subscription:WebhookSubscription? = null
/**
* The history of the subscription event.
*/
@ApiMember(Description="The history of the subscription event.", Name="History")
var history:ArrayList<SubscriptionDeliveryResult> = ArrayList<SubscriptionDeliveryResult>()
/**
* The status of the response.
*/
@ApiMember(Description="The status of the response.", Name="ResponseStatus")
var responseStatus:ResponseStatus? = null
}
open class WebhookSubscription
{
var id:String? = null
var name:String? = null
var event:String? = null
var isActive:Boolean? = null
var createdDateUtc:Date? = null
var createdById:String? = null
var lastModifiedDateUtc:Date? = null
var config:SubscriptionConfig? = null
}
open class SubscriptionConfig
{
var url:String? = null
var contentType:String? = null
var secret:String? = null
}
open class SubscriptionDeliveryResult
{
var attemptedDateUtc:Date? = null
var statusDescription:String? = null
var statusCode:HttpStatusCode? = null
var subscriptionId:String? = null
var id:String? = null
var eventId:String? = null
}
Kotlin UpdateWebhookSubscriptionAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
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.pwc.de
Accept: application/x-msgpack
Content-Type: application/x-msgpack
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/x-msgpack 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"}}}