webhooks

Change a webhook target's events.

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

post/projects/{id}/webhooks/{webhookID}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/projects/{id}/webhooks/{webhookID}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Project ID

webhookIDinteger required

Webhook ID

Response

Updated webhook target

basic_auth_passwordstring
basic_auth_userstring

If provided, webhook requests will be sent with a Basic Auth header.

createdstring

A timestamp when this webhook target was created. You cannot change this value.

eventsstring[]

The webhook events which should fire this webhook target

idinteger

The generated ID of this webhook target

project_idinteger

The project ID of the project this webhook target belongs to

secretstring

If provided, webhook requests will be signed using HMAC. Check out the docs about how to use this: https://vikunja.io/docs/webhooks/#signing

target_urlstring

The target URL where the POST request with the webhook payload will be made

updatedstring

A timestamp when this webhook target was last updated. You cannot change this value.

user_idinteger

The user ID if this is a user-level webhook (mutually exclusive with ProjectID)

Changes

No recorded changes to this operation across all 74 revisions of this API.