Overview #
List webhook subscriptions #
GET
/api/admin/26.0/webhooks
Parameters
| Field | Type | Description |
|---|---|---|
| limit | integer | [Optional] Number of results to return (default 20, max 10000) |
| page | integer | [Optional] Page number to fetch (default 1) |
| sort_by | string | [Optional] Field to sort by (e.g. created_at, title) |
| sort_order | string | [Optional] Sort direction: asc or desc |
Headers
| Header | Value |
|---|---|
| X-Joonweb-Access-Token | jw_at_xxxxxxxxxxxx |
| Content-Type | application/json |
Request Example
Response
200 OK
{
"webhooks": [
{
"id": 1029,
"address": "https:\/\/yourapp.com\/webhooks\/orders-create",
"topic": "orders\/create",
"format": "json",
"created_at": "2026-08-27T11:31:04+02:00",
"updated_at": "2026-08-27T11:31:04+02:00"
}
],
"pagination": {
"current_page": 1,
"per_page": 20,
"total": 1,
"total_pages": 1
}
}Create webhook #
POST
/api/admin/26.0/webhooks
Parameters
| Field | Type | Description |
|---|---|---|
| topic | string | [Required] Event topic (e.g. orders/create) |
| address | string | [Required] Endpoint URL to receive payload |
| format | string | [Optional] json or xml (default json) |
Headers
| Header | Value |
|---|---|
| X-Joonweb-Access-Token | jw_at_xxxxxxxxxxxx |
| Content-Type | application/json |
Request Example
Request Body
{
"webhook": {
"address": "example_address",
"event": "example_event",
"app_id": 104593,
"secret": "example_secret"
}
}
Response
200 OK
{
"webhook": {
"id": 1029,
"address": "https:\/\/yourapp.com\/webhooks\/orders-create",
"topic": "orders\/create",
"format": "json",
"created_at": "2026-08-27T11:31:04+02:00",
"updated_at": "2026-08-27T11:31:04+02:00"
}
}Update webhook #
PUT
/api/admin/26.0/webhooks
Parameters
| Field | Type | Description |
|---|---|---|
| topic | string | [Required] Event topic (e.g. orders/create) |
| address | string | [Required] Endpoint URL to receive payload |
| format | string | [Optional] json or xml (default json) |
Headers
| Header | Value |
|---|---|
| X-Joonweb-Access-Token | jw_at_xxxxxxxxxxxx |
| Content-Type | application/json |
Request Example
Request Body
{
"webhook": []
}
Response
200 OK
{
"webhook": {
"id": 1029,
"address": "https:\/\/yourapp.com\/webhooks\/orders-create",
"topic": "orders\/create",
"format": "json",
"created_at": "2026-08-27T11:31:04+02:00",
"updated_at": "2026-08-27T11:31:04+02:00"
}
}Get webhook #
GET
/api/admin/26.0/webhooks/{id}
Parameters
| Field | Type | Description |
|---|---|---|
| id | integer/string | [Required] The resource ID or handle |
Headers
| Header | Value |
|---|---|
| X-Joonweb-Access-Token | jw_at_xxxxxxxxxxxx |
| Content-Type | application/json |
Request Example
Response
200 OK
{
"webhook": {
"id": 1029,
"address": "https:\/\/yourapp.com\/webhooks\/orders-create",
"topic": "orders\/create",
"format": "json",
"created_at": "2026-08-27T11:31:04+02:00",
"updated_at": "2026-08-27T11:31:04+02:00"
}
}Delete webhook #
DELETE
/api/admin/26.0/webhooks/{id}
Parameters
| Field | Type | Description |
|---|---|---|
| id | integer/string | [Required] The resource ID or handle |
Headers
| Header | Value |
|---|---|
| X-Joonweb-Access-Token | jw_at_xxxxxxxxxxxx |
| Content-Type | application/json |
Request Example
Response
200 OK
{
"success": true,
"message": "Deleted successfully"
}Trigger internal webhook #
POST
/api/admin/26.0/internal/webhooks/deliver
Parameters
| Field | Type | Description |
|---|---|---|
| topic | string | [Required] Event topic (e.g. orders/create) |
| address | string | [Required] Endpoint URL to receive payload |
| format | string | [Optional] json or xml (default json) |
Headers
| Header | Value |
|---|---|
| X-Joonweb-Access-Token | jw_at_xxxxxxxxxxxx |
| Content-Type | application/json |
Request Example
Response
200 OK
{
"webhook": {
"id": 1029,
"address": "https:\/\/yourapp.com\/webhooks\/orders-create",
"topic": "orders\/create",
"format": "json",
"created_at": "2026-08-27T11:31:04+02:00",
"updated_at": "2026-08-27T11:31:04+02:00"
}
}