Webhooks

Update webhook

Updates a webhook. Requires admin privileges.

patch/webhooks/{id}

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/webhooks/{id}
Auth: one of:
- HTTP bearer
- API key in header X-Api-Key

Path parameters

idstring required

Example:1357158568008091264

ID of the webhook to update

Request body

namestring

Name/title of the webhook

urlstring url

URL endpoint for the webhook

accessTokenstring nullable

Access token for webhook authentication

eventsstring nullable

Comma-separated list of events that trigger the webhook

excludedEventsstring nullable

Comma-separated list of events excluded from the webhook

Example request

{
  "name": "Webhook Updates",
  "url": "https://service.example.com/planka",
  "accessToken": "secret_token_123",
  "events": "cardCreate,cardUpdate,cardDelete",
  "excludedEvents": "userCreate,userUpdate,userDelete"
}

Response

Webhook updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "name": "Webhook Updates",
    "url": "https://webhook.example.com/planka",
    "accessToken": "secret_token_123",
    "events": [
      "cardCreate",
      "cardUpdate",
      "cardDelete"
    ],
    "excludedEvents": [
      "userCreate",
      "userUpdate",
      "userDelete"
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.