Webhook Endpoints

Endpointhttps://api.kontorion.eu/v1

List webhook endpoints

GET

https://api.kontorion.eu/v1

/webhook-endpoints

Returns a paginated list of the org's outbound webhook endpoints.

List webhook endpoints › query Parameters

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

Opaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.

List webhook endpoints › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

List webhook endpoints › Responses

array | null · required

object · required

Create a webhook endpoint

POST

https://api.kontorion.eu/v1

/webhook-endpoints

Creates a new outbound webhook endpoint.

Create a webhook endpoint › Headers

Idempotency-Key

string · required

Unique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Create a webhook endpoint › Request Body

description

string

event_types

array | null

secret_id

string · uuid

url

string

Create a webhook endpoint › Responses

Created

object · required

POST/webhook-endpoints

curl --request POST \
  --url https://api.kontorion.eu/v1/webhook-endpoints \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "description": "description",
  "event_types": [
    "string"
  ],
  "secret_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "url": "url"
}
'

shell

Example Request Body

{
  "description": "description",
  "event_types": [
    "string"
  ],
  "secret_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "url": "url"
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "event_types": [
      "string"
    ],
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "secret_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "status": "status",
    "updated_at": "2024-08-25T15:00:00Z",
    "url": "url"
  }
}

json

application/json

Delete a webhook endpoint

DELETE

https://api.kontorion.eu/v1

/webhook-endpoints/{id}

Delete a webhook endpoint › path Parameters

id

string · uuid · required

Webhook endpoint UUID

Delete a webhook endpoint › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Delete a webhook endpoint › Responses

No Content

No data returned

Update a webhook endpoint

PATCH

https://api.kontorion.eu/v1

/webhook-endpoints/{id}

Partially updates a webhook endpoint (URL, description, event_types, status, secret_id).

Update a webhook endpoint › path Parameters

id

string · uuid · required

Webhook endpoint UUID

Update a webhook endpoint › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a webhook endpoint › Request Body

clear_secret

boolean

description

string

event_types

array | null

secret_id

string · uuid

status

string

url

string

Update a webhook endpoint › Responses

object · required

PATCH/webhook-endpoints/{id}

curl --request PATCH \
  --url https://api.kontorion.eu/v1/webhook-endpoints/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "clear_secret": true,
  "description": "description",
  "event_types": [
    "string"
  ],
  "secret_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "status": "status",
  "url": "url"
}
'

shell

Example Request Body

{
  "clear_secret": true,
  "description": "description",
  "event_types": [
    "string"
  ],
  "secret_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "status": "status",
  "url": "url"
}

json

Example Responses

{
  "data": {
    "created_at": "2024-08-25T15:00:00Z",
    "description": "description",
    "event_types": [
      "string"
    ],
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "secret_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "status": "status",
    "updated_at": "2024-08-25T15:00:00Z",
    "url": "url"
  }
}

json

application/json

List webhook delivery attempts for an endpoint

GET

https://api.kontorion.eu/v1

/webhook-endpoints/{id}/deliveries

Returns the most recent delivery attempts (delivered, failed, pending, exhausted) ordered newest first.

List webhook delivery attempts for an endpoint › path Parameters

id

string · uuid · required

Webhook endpoint UUID

List webhook delivery attempts for an endpoint › query Parameters

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

List webhook delivery attempts for an endpoint › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List webhook delivery attempts for an endpoint › Responses

array | null · required

object · required

GET/webhook-endpoints/{id}/deliveries

curl --request GET \
  --url https://api.kontorion.eu/v1/webhook-endpoints/:id/deliveries

shell

Example Responses

{
  "data": [
    {
      "attempts": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "endpoint_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "event_type": "event_type",
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "idempotency_key": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "last_error": "last_error",
      "max_attempts": 0,
      "next_retry_at": "2024-08-25T15:00:00Z",
      "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "payload": "payload",
      "status": "status",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Manually requeue a webhook delivery

POST

https://api.kontorion.eu/v1

/webhook-endpoints/{id}/deliveries/{delivery_id}/replay

Flips the delivery back into 'failed' state with next_retry_at=now so the retry sweep picks it up immediately. Use to recover from a customer endpoint outage that has since cleared.

Manually requeue a webhook delivery › path Parameters

id

string · uuid · required

Webhook endpoint UUID

delivery_id

string · uuid · required

Delivery UUID

Manually requeue a webhook delivery › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Manually requeue a webhook delivery › Responses

Accepted

object · required

POST/webhook-endpoints/{id}/deliveries/{delivery_id}/replay

curl --request POST \
  --url https://api.kontorion.eu/v1/webhook-endpoints/:id/deliveries/:delivery_id/replay \
  --header 'Idempotency-Key: <string>'

shell

Example Responses

{
  "data": {
    "attempts": 0,
    "created_at": "2024-08-25T15:00:00Z",
    "endpoint_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "event_type": "event_type",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "idempotency_key": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "last_error": "last_error",
    "max_attempts": 0,
    "next_retry_at": "2024-08-25T15:00:00Z",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "payload": "payload",
    "status": "status",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Users Workspaces

List webhook endpoints

GET

https://api.kontorion.eu/v1

/webhook-endpoints

Returns a paginated list of the org's outbound webhook endpoints.

List webhook endpoints › query Parameters

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

List webhook endpoints › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List webhook endpoints › Responses

array | null · required

object · required

Create a webhook endpoint

POST

https://api.kontorion.eu/v1

/webhook-endpoints

Creates a new outbound webhook endpoint.

Create a webhook endpoint › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Create a webhook endpoint › Request Body

description

string

event_types

array | null

secret_id

string · uuid

url

string

Create a webhook endpoint › Responses

Created

object · required

Delete a webhook endpoint

DELETE

https://api.kontorion.eu/v1

/webhook-endpoints/{id}

Delete a webhook endpoint › path Parameters

id

string · uuid · required

Webhook endpoint UUID

Delete a webhook endpoint › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Delete a webhook endpoint › Responses

No Content

No data returned

Update a webhook endpoint

PATCH

https://api.kontorion.eu/v1

/webhook-endpoints/{id}

Partially updates a webhook endpoint (URL, description, event_types, status, secret_id).

Update a webhook endpoint › path Parameters

id

string · uuid · required

Webhook endpoint UUID

Update a webhook endpoint › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a webhook endpoint › Request Body

clear_secret

boolean

description

string

event_types

array | null

secret_id

string · uuid

status

string

url

string

Update a webhook endpoint › Responses

object · required

List webhook delivery attempts for an endpoint

GET

https://api.kontorion.eu/v1

/webhook-endpoints/{id}/deliveries

Returns the most recent delivery attempts (delivered, failed, pending, exhausted) ordered newest first.

List webhook delivery attempts for an endpoint › path Parameters

id

string · uuid · required

Webhook endpoint UUID

List webhook delivery attempts for an endpoint › query Parameters

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

List webhook delivery attempts for an endpoint › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List webhook delivery attempts for an endpoint › Responses

array | null · required

object · required

Manually requeue a webhook delivery

POST

https://api.kontorion.eu/v1

/webhook-endpoints/{id}/deliveries/{delivery_id}/replay

Flips the delivery back into 'failed' state with next_retry_at=now so the retry sweep picks it up immediately. Use to recover from a customer endpoint outage that has since cleared.

Manually requeue a webhook delivery › path Parameters

id

string · uuid · required

Webhook endpoint UUID

delivery_id

string · uuid · required

Delivery UUID

Manually requeue a webhook delivery › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Manually requeue a webhook delivery › Responses

Accepted

object · required