Report Filing Service
| POST | /sync/webhooks/subscriptions/{Id}/update |
|---|
/** @description 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.")
export class UpdateWebhookSubscriptionBase implements IPost, IConfigurable
{
/** @description The unique identifier of the subscriber. */
// @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")
public id: string;
/** @description The name of the subscription. */
// @ApiMember(Description="The name of the subscription.", Name="Name")
public name: string;
/** @description The name of the subscribed event. */
// @ApiMember(Description="The name of the subscribed event.", Name="Event")
public event: 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.", 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 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 currentSecret: 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.", Name="NewSecret")
public newSecret: string;
/** @description Indicates whether the subscription is enabled or disabled. */
// @ApiMember(Description="Indicates whether the subscription is enabled or disabled.", Name="IsActive")
public isActive?: boolean;
/** @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. */
// @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 publicKeyXml: string;
public constructor(init?: Partial<UpdateWebhookSubscriptionBase>) { (Object as any).assign(this, init); }
}
export class SubscriptionConfig
{
public url: string;
public contentType: string;
public secret: string;
public constructor(init?: Partial<SubscriptionConfig>) { (Object as any).assign(this, init); }
}
export class WebhookSubscription
{
public id: string;
public name: string;
public event: string;
public isActive: boolean;
public createdDateUtc: string;
public createdById: string;
public lastModifiedDateUtc: string;
public config: SubscriptionConfig;
public constructor(init?: Partial<WebhookSubscription>) { (Object as any).assign(this, init); }
}
export class SubscriptionDeliveryResult
{
public attemptedDateUtc: string;
public statusDescription: string;
public statusCode: HttpStatusCode;
public subscriptionId: string;
public id: string;
public eventId: string;
public constructor(init?: Partial<SubscriptionDeliveryResult>) { (Object as any).assign(this, init); }
}
/** @description Represents a service response that encapsulates a webhook subscription. */
// @Api(Description="Represents a service response that encapsulates a webhook subscription.")
export class SubscriptionResponse
{
/** @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. */
// @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 subscription: WebhookSubscription;
/** @description The history of the subscription event. */
// @ApiMember(Description="The history of the subscription event.", Name="History")
public history: SubscriptionDeliveryResult[];
/** @description The status of the response. */
// @ApiMember(Description="The status of the response.", Name="ResponseStatus")
public responseStatus: ResponseStatus;
public constructor(init?: Partial<SubscriptionResponse>) { (Object as any).assign(this, init); }
}
/** @description Represents a request to update a webhook subscription specified by its unique identifier. */
// @Api(Description="Represents a request to update a webhook subscription specified by its unique identifier.")
export class UpdateWebhookSubscription extends UpdateWebhookSubscriptionBase
{
public constructor(init?: Partial<UpdateWebhookSubscription>) { super(init); (Object as any).assign(this, init); }
}
TypeScript UpdateWebhookSubscription DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/webhooks/subscriptions/{Id}/update HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateWebhookSubscription 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>
</UpdateWebhookSubscription>
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>