Webhooks

Configure webhook subscriptions to receive real-time HTTP POST notifications.

Subscribable events and their payload schemas (the data field of each delivered event):

Shipment lifecycle — shipment_created, shipment_updated, shipment_deleted. Payload: ShipmentResponseDto for created / updated, WebhookDeletedShipmentDto for deleted.
Account lifecycle — account_updated, account_deleted. Payload: WebhookAccountDto for updated, WebhookDeletedAccountDto for deleted.
Configuration lifecycle — configuration_created, configuration_updated, configuration_deleted. Payload: WebhookConfigurationDto, which identifies the affected configuration by courierId and profileId.

Lifecycle events fire on every change regardless of how it was triggered. Webhooks are automatically suspended after repeated delivery failures.

List webhooks

GET

https://api.chameleoon.sk

/v2/webhooks

Returns a paginated list of registered webhooks for the authenticated account.

List webhooks › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

pageSize

integer · min: 1 · max: 100

Number of items per page

Default: 20

status

WebhookStatusEnum[] · style: form

Filter webhooks by status. Accepts multiple comma-separated values. When omitted, returns all webhooks regardless of status.

Enum values:

active

suspended

inactive

List webhooks › Responses

Paginated list of webhooks

PagedWebhookListDto

page

integer · required

Current page number

pageSize

integer · required

Number of items per page

totalPages

integer · required

Total number of pages

nextPage

boolean · required

Whether a next page exists

previousPage

boolean · required

Whether a previous page exists

itemsCount

integer · required

Total number of items across all pages

WebhookDto[]

List of webhooks

GET/v2/webhooks

curl https://api.chameleoon.sk/v2/webhooks \
  --header 'X-Chameleoon-ApiKey: <api-key>'

Example Responses

{
  "page": 1,
  "pageSize": 20,
  "totalPages": 1,
  "nextPage": false,
  "previousPage": false,
  "itemsCount": 2,
  "items": [
    {
      "id": "38bf26ed-a328-4663-a6e2-fe2d6687f42d",
      "type": "shipment_created",
      "url": "https://example.com/webhooks/shipments",
      "created": "2025-09-01T08:00:00.000",
      "status": "active",
      "changed": "2025-09-01T08:00:00.000"
    },
    {
      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
      "type": "shipment_updated",
      "url": "https://example.com/webhooks/updates",
      "created": "2025-09-02T10:00:00.000",
      "status": "suspended",
      "changed": "2025-09-05T15:30:00.000"
    }
  ]
}

json

application/json

Create webhook

POST

https://api.chameleoon.sk

/v2/webhooks

Registers a new webhook subscription.

One webhook subscription listens to one event type — see the type field below for the full list of subscribable events and their payloads. Create multiple subscriptions to receive multiple event types (the same URL can be used for several subscriptions).

Create webhook › Request Body

Request to create a webhook subscription

CreateWebhookRequestDto

type

string · enum · required

Event type to subscribe to.

shipment_created / shipment_updated / shipment_deleted — shipment lifecycle events. Payload: ShipmentResponseDto (created / updated) or WebhookDeletedShipmentDto (deleted).
account_updated / account_deleted — account lifecycle events. Payload: WebhookAccountDto (updated) or WebhookDeletedAccountDto (deleted).
configuration_created / configuration_updated / configuration_deleted — courier configuration lifecycle events. Payload: WebhookConfigurationDto, which identifies the affected configuration by courierId and profileId.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri · required

HTTPS endpoint URL where webhook event payloads will be delivered via POST

Create webhook › Responses

Webhook created successfully

Webhook subscription details

WebhookDto

id

string · uuid · required

Unique webhook subscription identifier

type

string · enum · required

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri · required

HTTPS endpoint URL where webhook event payloads will be delivered via POST

created

string · date-time · required

Timestamp when the webhook subscription was created (format yyyy-MM-ddTHH:mm:ss.fff)

status

WebhookStatusEnum · enum · required

Webhook delivery status:

active: Webhooks are being sent normally
suspended: Automatically paused due to client-side processing errors
inactive: Manually paused by the user

Enum values:

active

suspended

inactive

changed

string · date-time · required

Timestamp of the most recent modification to this webhook subscription

Get webhook by ID

GET

https://api.chameleoon.sk

/v2/webhooks/{id}

Returns details of a specific webhook subscription.

Get webhook by ID › path Parameters

id

string · uuid · required

Unique webhook identifier

Get webhook by ID › Responses

Webhook details

Webhook subscription details

WebhookDto

id

string · uuid · required

Unique webhook subscription identifier

type

string · enum · required

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri · required

HTTPS endpoint URL where webhook event payloads will be delivered via POST

created

string · date-time · required

Timestamp when the webhook subscription was created (format yyyy-MM-ddTHH:mm:ss.fff)

status

WebhookStatusEnum · enum · required

Webhook delivery status:

active: Webhooks are being sent normally
suspended: Automatically paused due to client-side processing errors
inactive: Manually paused by the user

Enum values:

active

suspended

inactive

changed

string · date-time · required

Timestamp of the most recent modification to this webhook subscription

Update webhook

PUT

https://api.chameleoon.sk

/v2/webhooks/{id}

Updates an existing webhook subscription. Only the fields you provide are changed; omitted fields stay the same.

See the type field below for the full list of subscribable events and their payloads.

Update webhook › path Parameters

id

string · uuid · required

Unique webhook identifier

Update webhook › Request Body

Request to update a webhook subscription. Only provided fields are updated; omitted fields remain unchanged.

UpdateWebhookRequestDto

type

string · enum

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri

HTTPS endpoint URL where webhook event payloads will be delivered via POST

status

WebhookStatusEnum · enum

Webhook delivery status:

active: Webhooks are being sent normally
suspended: Automatically paused due to client-side processing errors
inactive: Manually paused by the user

Enum values:

active

suspended

inactive

Update webhook › Responses

Webhook updated successfully

Webhook subscription details

WebhookDto

id

string · uuid · required

Unique webhook subscription identifier

type

string · enum · required

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri · required

HTTPS endpoint URL where webhook event payloads will be delivered via POST

created

string · date-time · required

Timestamp when the webhook subscription was created (format yyyy-MM-ddTHH:mm:ss.fff)

status

WebhookStatusEnum · enum · required

Webhook delivery status:

active: Webhooks are being sent normally
suspended: Automatically paused due to client-side processing errors
inactive: Manually paused by the user

Enum values:

active

suspended

inactive

changed

string · date-time · required

Timestamp of the most recent modification to this webhook subscription

Delete webhook

DELETE

https://api.chameleoon.sk

/v2/webhooks/{id}

Deletes a webhook subscription.

Delete webhook › path Parameters

id

string · uuid · required

Unique webhook identifier

Delete webhook › Responses

Webhook deleted successfully

No data returned

Chameleoon Delivery Authentication

Configure webhook subscriptions to receive real-time HTTP POST notifications.

Subscribable events and their payload schemas (the data field of each delivered event):

Shipment lifecycle — shipment_created, shipment_updated, shipment_deleted. Payload: ShipmentResponseDto for created / updated, WebhookDeletedShipmentDto for deleted.
Account lifecycle — account_updated, account_deleted. Payload: WebhookAccountDto for updated, WebhookDeletedAccountDto for deleted.
Configuration lifecycle — configuration_created, configuration_updated, configuration_deleted. Payload: WebhookConfigurationDto, which identifies the affected configuration by courierId and profileId.

Lifecycle events fire on every change regardless of how it was triggered. Webhooks are automatically suspended after repeated delivery failures.

List webhooks

GET

https://api.chameleoon.sk

/v2/webhooks

Returns a paginated list of registered webhooks for the authenticated account.

List webhooks › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

pageSize

integer · min: 1 · max: 100

Number of items per page

Default: 20

status

WebhookStatusEnum[] · style: form

Filter webhooks by status. Accepts multiple comma-separated values. When omitted, returns all webhooks regardless of status.

Enum values:

active

suspended

inactive

List webhooks › Responses

Paginated list of webhooks

PagedWebhookListDto

page

integer · required

Current page number

pageSize

integer · required

Number of items per page

totalPages

integer · required

Total number of pages

nextPage

boolean · required

Whether a next page exists

previousPage

boolean · required

Whether a previous page exists

itemsCount

integer · required

Total number of items across all pages

WebhookDto[]

List of webhooks

Create webhook

POST

https://api.chameleoon.sk

/v2/webhooks

Registers a new webhook subscription.

Create webhook › Request Body

Request to create a webhook subscription

CreateWebhookRequestDto

type

string · enum · required

Event type to subscribe to.

shipment_created / shipment_updated / shipment_deleted — shipment lifecycle events. Payload: ShipmentResponseDto (created / updated) or WebhookDeletedShipmentDto (deleted).
account_updated / account_deleted — account lifecycle events. Payload: WebhookAccountDto (updated) or WebhookDeletedAccountDto (deleted).
configuration_created / configuration_updated / configuration_deleted — courier configuration lifecycle events. Payload: WebhookConfigurationDto, which identifies the affected configuration by courierId and profileId.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri · required

HTTPS endpoint URL where webhook event payloads will be delivered via POST

Create webhook › Responses

Webhook created successfully

Webhook subscription details

WebhookDto

id

string · uuid · required

Unique webhook subscription identifier

type

string · enum · required

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri · required

HTTPS endpoint URL where webhook event payloads will be delivered via POST

created

string · date-time · required

Timestamp when the webhook subscription was created (format yyyy-MM-ddTHH:mm:ss.fff)

status

WebhookStatusEnum · enum · required

Webhook delivery status:

active: Webhooks are being sent normally
suspended: Automatically paused due to client-side processing errors
inactive: Manually paused by the user

Enum values:

active

suspended

inactive

changed

string · date-time · required

Timestamp of the most recent modification to this webhook subscription

Get webhook by ID

GET

https://api.chameleoon.sk

/v2/webhooks/{id}

Returns details of a specific webhook subscription.

Get webhook by ID › path Parameters

id

string · uuid · required

Unique webhook identifier

Get webhook by ID › Responses

Webhook details

Webhook subscription details

WebhookDto

id

string · uuid · required

Unique webhook subscription identifier

type

string · enum · required

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri · required

HTTPS endpoint URL where webhook event payloads will be delivered via POST

created

string · date-time · required

Timestamp when the webhook subscription was created (format yyyy-MM-ddTHH:mm:ss.fff)

status

WebhookStatusEnum · enum · required

Webhook delivery status:

active: Webhooks are being sent normally
suspended: Automatically paused due to client-side processing errors
inactive: Manually paused by the user

Enum values:

active

suspended

inactive

changed

string · date-time · required

Timestamp of the most recent modification to this webhook subscription

Update webhook

PUT

https://api.chameleoon.sk

/v2/webhooks/{id}

Updates an existing webhook subscription. Only the fields you provide are changed; omitted fields stay the same.

See the type field below for the full list of subscribable events and their payloads.

Update webhook › path Parameters

id

string · uuid · required

Unique webhook identifier

Update webhook › Request Body

Request to update a webhook subscription. Only provided fields are updated; omitted fields remain unchanged.

UpdateWebhookRequestDto

type

string · enum

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri

HTTPS endpoint URL where webhook event payloads will be delivered via POST

status

WebhookStatusEnum · enum

Webhook delivery status:

active: Webhooks are being sent normally
suspended: Automatically paused due to client-side processing errors
inactive: Manually paused by the user

Enum values:

active

suspended

inactive

Update webhook › Responses

Webhook updated successfully

Webhook subscription details

WebhookDto

id

string · uuid · required

Unique webhook subscription identifier

type

string · enum · required

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

Enum values:

shipment_created

shipment_updated

shipment_deleted

account_updated

account_deleted

configuration_created

configuration_updated

configuration_deleted

url

string · uri · required

HTTPS endpoint URL where webhook event payloads will be delivered via POST

created

string · date-time · required

Timestamp when the webhook subscription was created (format yyyy-MM-ddTHH:mm:ss.fff)

status

WebhookStatusEnum · enum · required

Webhook delivery status:

active: Webhooks are being sent normally
suspended: Automatically paused due to client-side processing errors
inactive: Manually paused by the user

Enum values:

active

suspended

inactive

changed

string · date-time · required

Timestamp of the most recent modification to this webhook subscription