Skip to content
Ideasoft
Webhooks

Managing Webhooks

Webhook records are managed through the Admin API client_webhooks service. For the full parameter and schema details see the ClientWebhook reference.

Create a webhook

Creates a new webhook with an address and topic.

Code
POST https://your-store.myideasoft.com/admin-api/client_webhooks

Request body:

JSONCode
{ "topic": "product/create", "address": "https://your-app.example.com/webhook", "status": 1 }

Response:

JSONCode
{ "id": 1, "client": { "id": 1, "name": "Sendloop" }, "topic": "product/create", "address": "https://your-app.example.com/webhook", "status": 1, "createdAt": "2022-07-26T10:59:04+03:00", "updatedAt": "2022-07-26T10:59:04+03:00" }

List webhooks

Code
GET https://your-store.myideasoft.com/admin-api/client_webhooks

Response:

JSONCode
[ { "id": 1, "client": { "id": 1, "name": "Sendloop" }, "topic": "product/create", "address": "https://your-app.example.com/webhook", "status": 1, "createdAt": "2022-07-26T10:58:54+03:00", "updatedAt": "2022-07-26T10:58:54+03:00" }, { "id": 2, "client": { "id": 1, "name": "Sendloop" }, "topic": "payment/create", "address": "https://your-app.example.com/webhook", "status": 1, "createdAt": "2022-07-26T11:05:21+03:00", "updatedAt": "2022-07-26T11:05:21+03:00" } ]

Update a webhook

Code
PUT https://your-store.myideasoft.com/admin-api/client_webhooks/{webhook_id}

Request body:

JSONCode
{ "topic": "product/create", "address": "https://your-app.example.com/webhook", "status": 1 }

The response is the updated webhook record.

Delete a webhook

Permanently deletes the webhook.

Code
DELETE https://your-store.myideasoft.com/admin-api/client_webhooks/{webhook_id}

A successful delete returns 204 No Content with no response body.

fields

The fields property seen in examples of older documentation was removed in V8 — do not include it in request bodies.

Last modified on