API reference

List webhook endpoints

GET

/api/v1/organizations/{organizationId}/webhooks

const url = 'https://api.koneth.com/api/v1/organizations/b7378db4-5a7a-4e69-a8df-04f2e6d94243/webhooks';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.koneth.com/api/v1/organizations/b7378db4-5a7a-4e69-a8df-04f2e6d94243/webhooks \
  --header 'Authorization: Bearer <token>'

Returns the organization’s webhook endpoints with their event subscriptions, target server, and verification status.

Authorizations

consoleSession

Parameters

Path Parameters

organizationId

required

string format: uuid

UUID of the organization the signed-in user belongs to.

Example

b7378db4-5a7a-4e69-a8df-04f2e6d94243

Responses

200

Endpoints returned.

application/json

object

endpoints

required

Array<object>

object

required

string format: uuid

name

required

string

url

required

string format: uri

eventsJson

required

JSON-encoded array of the event types this endpoint subscribes to.

string

serverId

Target server, or null when the endpoint receives events from every server in the organization.

string | null format: uuid

status

required

Only active endpoints receive deliveries.

string

Allowed values: pending active disabled

verifiedAt

Time the endpoint last answered a verification challenge.

string | null format: date-time

createdAt

required

string format: date-time

updatedAt

string format: date-time

Example

{
  "endpoints": [
    {
      "id": "0f6f2d88-9357-4ce6-9b9e-76db2f98bb2e",
      "name": "api.example.com",
      "url": "https://api.example.com/koneth/events",
      "eventsJson": "[\"finance.transaction.completed\",\"position.closed\",\"position.opened\"]",
      "serverId": null,
      "status": "active",
      "verifiedAt": "2026-09-10T18:02:11.000Z",
      "createdAt": "2026-09-10T17:55:02.000Z",
      "updatedAt": "2026-09-10T18:02:11.000Z"
    }
  ]
}

401

The Console session is missing or expired.

application/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Authentication required"
}

403

The signed-in user is not an organization Owner or Finance member.

application/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Insufficient organization permission"
}

500

Unexpected server error.

application/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Internal server error"
}