Interface IWebhookRequestService
Provides functionality for managing webhook requests.
Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IWebhookRequestServiceRemarks
Webhook requests are queued when events occur and are processed asynchronously to send HTTP callbacks to configured webhook endpoints.
Methods
View SourceCreateAsync(Guid, string, object?)
Creates a webhook request.
Declaration
Task<WebhookRequest> CreateAsync(Guid webhookKey, string eventAlias, object? payload)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | webhookKey | The key of the webhook. |
| string | eventAlias | The alias of the event that is creating the request. |
| object | payload | The payload you want to send with your request. |
Returns
| Type | Description |
|---|---|
| Task<WebhookRequest> | The created WebhookRequest webhook |
DeleteAsync(WebhookRequest)
Deletes a webhook request
Declaration
Task DeleteAsync(WebhookRequest webhookRequest)Parameters
| Type | Name | Description |
|---|---|---|
| WebhookRequest | webhookRequest | The webhook request to be deleted. |
Returns
| Type | Description |
|---|---|
| Task |
GetAllAsync()
Gets all of the webhook requests in the current database.
Declaration
Task<IEnumerable<WebhookRequest>> GetAllAsync()Returns
| Type | Description |
|---|---|
| Task<IEnumerable<WebhookRequest>> | An enumerable of WebhookRequest objects. |
UpdateAsync(WebhookRequest)
Update a webhook request.
Declaration
Task<WebhookRequest> UpdateAsync(WebhookRequest webhookRequest)Parameters
| Type | Name | Description |
|---|---|---|
| WebhookRequest | webhookRequest | The webhook request you want to update. |
Returns
| Type | Description |
|---|---|
| Task<WebhookRequest> | The updated WebhookRequest webhook |