igdbclient-core/ru.pixnews.igdbclient/IgdbWebhookApi

IgdbWebhookApi

interface IgdbWebhookApi

IgdbWebhookApi allows you to manage webhooks using the IGDB Webhook API

See https://api-docs.igdb.com/#webhooks

Types

Link copied to clipboard
enum WebhookMethod : Enum<IgdbWebhookApi.WebhookMethod>

The type of data change event for which a subscription will be created and notifications will be sent to the webhook url

Functions

Link copied to clipboard
abstract suspend fun deleteWebhook(webhookId: IgdbWebhookId): IgdbResult<List<IgdbWebhook>, IgdbHttpErrorResponse>

Removes a registered webhook.

Link copied to clipboard
abstract suspend fun getAllWebhooks(): IgdbResult<List<IgdbWebhook>, IgdbHttpErrorResponse>

Returns all registered webhooks.

Link copied to clipboard
abstract suspend fun getWebhook(webhookId: IgdbWebhookId): IgdbResult<List<IgdbWebhook>, IgdbHttpErrorResponse>

Returns information about a specific webhook.

Link copied to clipboard
abstract suspend fun registerWebhook(endpoint: IgdbEndpoint<*>, url: String, method: IgdbWebhookApi.WebhookMethod, secret: String): IgdbResult<List<IgdbWebhook>, IgdbHttpErrorResponse>

Registers a new webhook.

Link copied to clipboard
abstract suspend fun testWebhook(endpoint: IgdbEndpoint<*>, webhookId: IgdbWebhookId, entityId: String): IgdbResult<String, IgdbHttpErrorResponse>

Allows you to test a registered webhook.