Webhooks (subscriptions): Bimp API methods
Bimp API methods for the “Webhooks (subscriptions)” resource (/org2/webhooks/…): 3 methods. Base URL: https://app.bimpsoft.com. All requests except login pass the company token in the access-token header — see Getting started with the API.
| Method | What it does |
|---|---|
POST /org2/webhooks/destinations/list | |
POST /org2/webhooks/destinations/upsert | |
POST /org2/webhooks/destinations/delete |
destinations/list
POST /org2/webhooks/destinations/list
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
eventKind | string (“inventory_balance”) | string (“product_upsert”) | string (“order_status”) | yes |
Response: data field
| Field | Type | Description |
|---|---|---|
[].id | string (uuid) | |
[].companyId | string (uuid) | |
[].eventKind | string | |
[].name | string | null | |
[].url | string | |
[].enabled | integer | |
[].orgId | string (uuid) | null | |
[].warehouseId | string (uuid) | null | |
[].extraHeaders | string | null | |
[].hasSecret | boolean |
curl -X POST 'https://app.bimpsoft.com/org2/webhooks/destinations/list' \
-H 'access-token: <company token>' \
-H 'Content-Type: application/json' \
-d '{"eventKind":"string"}'destinations/upsert
POST /org2/webhooks/destinations/upsert
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
eventKind | string (“inventory_balance”) | string (“product_upsert”) | string (“order_status”) | yes | |
id | string (uuid) | ||
name | string | null | ||
url | string | yes | |
secret | string | null | ||
enabled | boolean | ||
orgId | string (uuid) | null | ||
warehouseId | string (uuid) | null | ||
extraHeaders | object |
Response: data field
| Field | Type | Description |
|---|---|---|
id | string (uuid) |
curl -X POST 'https://app.bimpsoft.com/org2/webhooks/destinations/upsert' \
-H 'access-token: <company token>' \
-H 'Content-Type: application/json' \
-d '{"eventKind":"string","url":"string"}'destinations/delete
POST /org2/webhooks/destinations/delete
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
eventKind | string (“inventory_balance”) | string (“product_upsert”) | string (“order_status”) | yes | |
id | string (uuid) | yes |
Response: data field
| Field | Type | Description |
|---|---|---|
deleted | boolean |
curl -X POST 'https://app.bimpsoft.com/org2/webhooks/destinations/delete' \
-H 'access-token: <company token>' \
-H 'Content-Type: application/json' \
-d '{"eventKind":"string","id":"00000000-0000-0000-0000-000000000000"}'Interactive documentation with a test request option: https://app.bimpsoft.com/docs. The OpenAPI specification is updated together with Bimp; this page is generated from it automatically.