Sign in
Webhooks

Get all webhooks

Retrieves a list of all configured webhooks. Requires admin privileges.

get/webhooks

Request

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

Response

Webhooks retrieved successfully

Example response

{
  "items": [
    {
      "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.