Vikunja.API.Webhooks

Operations

Webhooks

projectsIdWebhooksGet

projectsIdWebhooksGet

Arguments

:: Id

"id" - Project ID

-> VikunjaRequest ProjectsIdWebhooksGet MimeNoContent [ModelsWebhook] MimeJSON

GET /projects/{id}/webhooks

Get all api webhook targets for the specified project

Get all api webhook targets for the specified project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdWebhooksGet

Instances

Produces ProjectsIdWebhooksGet MimeJSON

application/json

Defined in Vikunja.API.Webhooks

HasOptionalParam ProjectsIdWebhooksGet PerPage

Optional Param "per_page" - The maximum number of items per bucket per page. This parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Webhooks

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdWebhooksGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdWebhooksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdWebhooksGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdWebhooksGet contentType res accept

HasOptionalParam ProjectsIdWebhooksGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Webhooks

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdWebhooksGet contentType res accept -> Page -> VikunjaRequest ProjectsIdWebhooksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdWebhooksGet contentType res accept -> Page -> VikunjaRequest ProjectsIdWebhooksGet contentType res accept

projectsIdWebhooksPut

projectsIdWebhooksPut

Arguments

:: (Consumes ProjectsIdWebhooksPut MimeJSON, MimeRender MimeJSON ModelsWebhook)

=> ModelsWebhook

"webhook" - The webhook target object with required fields

-> Id

"id" - Project ID

-> VikunjaRequest ProjectsIdWebhooksPut MimeJSON ModelsWebhook MimeJSON

PUT /projects/{id}/webhooks

Create a webhook target

Create a webhook target which receives POST requests about specified events from a project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdWebhooksPut

Instances

Produces ProjectsIdWebhooksPut MimeJSON

application/json

Defined in Vikunja.API.Webhooks

Consumes ProjectsIdWebhooksPut MimeJSON

application/json

Defined in Vikunja.API.Webhooks

HasBodyParam ProjectsIdWebhooksPut ModelsWebhook

Body Param "webhook" - The webhook target object with required fields

Defined in Vikunja.API.Webhooks

Methods

setBodyParam :: (Consumes ProjectsIdWebhooksPut contentType, MimeRender contentType ModelsWebhook) => VikunjaRequest ProjectsIdWebhooksPut contentType res accept -> ModelsWebhook -> VikunjaRequest ProjectsIdWebhooksPut contentType res accept

projectsIdWebhooksWebhookIDDelete

projectsIdWebhooksWebhookIDDelete

Arguments

:: Id

"id" - Project ID

-> WebhookId

"webhookId" - Webhook ID

-> VikunjaRequest ProjectsIdWebhooksWebhookIDDelete MimeNoContent ModelsMessage MimeJSON

DELETE /projects/{id}/webhooks/{webhookID}

Deletes an existing webhook target

Delete any of the project's webhook targets.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdWebhooksWebhookIDDelete

Instances

Produces ProjectsIdWebhooksWebhookIDDelete MimeJSON

application/json

Defined in Vikunja.API.Webhooks

projectsIdWebhooksWebhookIDPost

projectsIdWebhooksWebhookIDPost

Arguments

:: Id

"id" - Project ID

-> WebhookId

"webhookId" - Webhook ID

-> VikunjaRequest ProjectsIdWebhooksWebhookIDPost MimeNoContent ModelsWebhook MimeJSON

POST /projects/{id}/webhooks/{webhookID}

Change a webhook target's events.

Change a webhook target's events. You cannot change other values of a webhook.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdWebhooksWebhookIDPost

Instances

Produces ProjectsIdWebhooksWebhookIDPost MimeJSON

application/json

Defined in Vikunja.API.Webhooks

webhooksEventsGet

webhooksEventsGet :: VikunjaRequest WebhooksEventsGet MimeNoContent [Text] MimeJSON

GET /webhooks/events

Get all possible webhook events

Get all possible webhook events to use when creating or updating a webhook target.

AuthMethod: AuthApiKeyJWTKeyAuth

data WebhooksEventsGet

Instances

Produces WebhooksEventsGet MimeJSON

application/json

Defined in Vikunja.API.Webhooks