Interface IWebhookResource

Namespace

Mailtrap.Webhooks

Assembly

Mailtrap.Abstractions.dll

Represents webhook resource.

public interface IWebhookResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Delete(CancellationToken)

Permanently deletes the webhook, represented by the current resource instance.

Task<Webhook> Delete(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<Webhook>

Deleted webhook details.

GetDetails(CancellationToken)

Gets details of the webhook, represented by the current resource instance.

Task<Webhook> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<Webhook>

Requested webhook details.

Update(UpdateWebhookRequest, CancellationToken)

Updates the webhook, represented by the current resource instance, with details specified by request.

Task<Webhook> Update(UpdateWebhookRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateWebhookRequest

Webhook details for update. Only properties set on the request are sent.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<Webhook>

Updated webhook details.