Webhooks (admin API)

Admin routes of the webhooks module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.

GET /v1/admin/webhooks

List webhook subscriptions

Parameters:

• page in query (number, min 1, optional).
• pageSize in query (number, min 1, max 100, optional).

Responses:

• 200: no description.

POST /v1/admin/webhooks

Create new webhook subscription

Request body: CreateWebhookDto.

Responses:

• 201: no description.

DELETE /v1/admin/webhooks/{id}

Delete webhook subscription

Parameters:

• id in path (string, required).

Responses:

• 204: no description.

GET /v1/admin/webhooks/{id}

Get webhook subscription

Parameters:

• id in path (string, required).

Responses:

• 200: no description.

PATCH /v1/admin/webhooks/{id}

Update webhook subscription

Parameters:

• id in path (string, required).

Request body: UpdateWebhookDto.

Responses:

• 200: no description.

GET /v1/admin/webhooks/{id}/deliveries

List deliveries for a webhook subscription

Parameters:

• id in path (string, required).
• page in query (number, min 1, optional).
• pageSize in query (number, min 1, max 100, optional).

Responses:

• 200: no description.

POST /v1/admin/webhooks/{id}/test

Send a test event to a webhook subscription

Parameters:

• id in path (string, required).

Responses:

• 201: no description. Body: object.

Schemas

CreateWebhookDto

• url (string, pattern ^https:\/\/, required).
• events (array of "cart.abandoned", "customer.created", "customer.updated", "inventory.low_stock", "inventory.out_of_stock", "inventory.restocked", "order.cancelled", "order.confirmed", "order.created", "order.delivered", "order.shipped", "order.status_changed", "payment.received", "payment.refunded", "product.created", "product.deleted", "product.updated", "return.approved", "return.refunded", "return.requested", "review.submitted", required).
• secret (string, optional).

UpdateWebhookDto

• isActive (boolean, optional).