View Source

Interface IWebhookService

Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IWebhookService

Methods

View Source

CreateAsync(IWebhook)

Creates a webhook.

Declaration
Task<Attempt<IWebhook, WebhookOperationStatus>> CreateAsync(IWebhook webhook)
Parameters
Type Name Description
IWebhook webhook

IWebhook to create.
Returns
Type Description
Task<Attempt<IWebhook, WebhookOperationStatus>>
View Source

DeleteAsync(Guid)

Deletes a webhook.

Declaration
Task<Attempt<IWebhook, WebhookOperationStatus>> DeleteAsync(Guid key)
Parameters
Type Name Description
Guid key

The unique key of the webhook.
Returns
Type Description
Task<Attempt<IWebhook, WebhookOperationStatus>>
View Source

GetAllAsync(Int32, Int32)

Gets all webhooks.

Declaration
Task<PagedModel<IWebhook>> GetAllAsync(int skip, int take)
Parameters
Type Name Description
System.Int32 skip
System.Int32 take
Returns
Type Description
Task<PagedModel<IWebhook>>
View Source

GetAsync(Guid)

Gets a webhook by its key.

Declaration
Task<IWebhook> GetAsync(Guid key)
Parameters
Type Name Description
Guid key

The unique key of the webhook.
Returns
Type Description
Task<IWebhook>
View Source

GetByAliasAsync(String)

Gets webhooks by event name.

Declaration
Task<IEnumerable<IWebhook>> GetByAliasAsync(string alias)
Parameters
Type Name Description
System.String alias
Returns
Type Description
Task<IEnumerable<IWebhook>>
View Source

UpdateAsync(IWebhook)

Updates a webhook.

Declaration
Task<Attempt<IWebhook, WebhookOperationStatus>> UpdateAsync(IWebhook webhook)
Parameters
Type Name Description
IWebhook webhook

IWebhook to update.
Returns
Type Description
Task<Attempt<IWebhook, WebhookOperationStatus>>