Skip to content
/
Register a new webhook

Kanbert (v1)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
https://api.kanbert.com/api/v1

Users

Operations

Clients

Operations

Projects

Operations

Tasks

Operations
Webhooks

Task Comments

Operations
Webhooks

Efforts

Operations

Contacts

Operations

Companies

Operations
Webhooks

Offers

Operations

Outgoing Invoices

Operations

Payments

Operations

Usergroups & Teams

Operations

Settings

Operations

Integration

Operations

Files

Operations

Custom Fields

Operations

Webhook Management

Operations

List all registered webhooks

Request

Required scopes: integration

Security
http or oauth2
Query
sortstring

Available sorts are url, is_active, created_at.
You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -title.

Example: sort=sort=-created_at,title
page[size]integer

The number of results that will be returned per page.

Default 30
page[cursor]string

The cursor to start the pagination from.

filterstring

Allowed filter fields (with allowed operators):

FieldTypeOperators
urlstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
created_atdatetimeeq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull

Filtering expression. Accepts either JSON (array/tree of conditions) or a readable string DSL.

You can check the full syntax at Docs Filtering section.

Special values:

  • me.id — current authenticated user id (usable on fields of type id). Example: id eq me.id
  • now — current date-time. Example: dueOn lt now
  • sow/eow — start/end of week. Examples: dueOn gt sow, dueOn lt eow
  • som/eom — start/end of month. Examples: dueOn gt som, dueOn lt eom
  • today — special date for today; with eq it expands to the whole day range. Example: dueOn eq today
  • today±Nd — relative day offset. Examples: today-30d, today+5d.
Example: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")
curl -i -X GET \
  'https://api.kanbert.com/api/v1/webhooks?sort=sort%3D-created_at%2Ctitle&page%5Bsize%5D=30&page%5Bcursor%5D=string&filter=title+contains+%22Acme%22+and+%28created_at+%3E%3D+%222024-01-01%22+or+client.name+contains+%22Corp%22%29' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The cursor paginated collection of WebhookData

Bodyapplication/json
dataArray of objects(WebhookData)required

The list of items

data[].​idstringrequired
data[].​urlstringrequired
data[].​client_idstring or nullrequired
data[].​project_idstring or nullrequired
data[].​eventstring(WebhookEvent)required
Enum"contact:create""contact:update""contact:delete""company:create""company:update""company:delete""task:create""task:update""task:delete""comment:create"
data[].​created_atstring(date-time)required
linksArray of stringsrequired
metaobjectrequired
meta.​pathstring or nullrequired

Base path for paginator generated URLs.

meta.​per_pageintegerrequired

Number of items shown per page.

meta.​next_cursorstring or nullrequired
meta.​next_cursor_urlstring or nullrequired
meta.​prev_cursorstring or nullrequired
meta.​prev_cursor_urlstring or nullrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "links": [
    "string"
  ],
  "meta": {
    "path": "string",
    "per_page": 0,
    "next_cursor": "string",
    "next_cursor_url": "string",
    "prev_cursor": "string",
    "prev_cursor_url": "string"
  }
}

Register a new webhook

Request

Required scopes: integration

Returns a signature_secret_key field, make sure to save it somewhere safe. It won't be returned again.

Security
http or oauth2
Bodyapplication/jsonrequired
urlstring(uri)<= 180 charactersrequired

Needs to be unique

project_idstring or null

Scope a webhook to a specific project to reduce the number of events sent
task:* and comment:* events have to be project-scoped

client_idstring or null

Scope a webhook to a specific client to reduce the number of events sent

eventstring(WebhookEvent)required

Event to subscribe to type WebhookEvent

Enum"contact:create""contact:update""contact:delete""company:create""company:update""company:delete""task:create""task:update""task:delete""comment:create"
curl -i -X POST \
  https://api.kanbert.com/api/v1/webhooks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "http://example.com",
    "project_id": "string",
    "client_id": "string",
    "event": "contact:create"
  }'

Responses

WebhookCreateData

Bodyapplication/json
idstringrequired
urlstringrequired
client_idstring or nullrequired
project_idstring or nullrequired
signature_secret_keystringrequired
eventstring(WebhookEvent)required
Enum"contact:create""contact:update""contact:delete""company:create""company:update""company:delete""task:create""task:update""task:delete""comment:create"
created_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "url": "string",
  "client_id": "string",
  "project_id": "string",
  "signature_secret_key": "string",
  "event": "contact:create",
  "created_at": "2019-08-24T14:15:22Z"
}

Delete a webhook

Request

Required scopes: integration

Security
http or oauth2
Path
idstringrequired
curl -i -X DELETE \
  'https://api.kanbert.com/api/v1/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response
No content

Schemas

Schemas