Base URL
https://{tenant}.logzi.com/api/integration_webhook/
Every request returns a JSON response. On success result.code == 1, on error result.code == 0. Webhook entries store the event notifications to be sent to the integration (e.g. new order, invoice issued). The sended field indicates whether the webhook has already been sent.
/api/integration_webhook/get
Retrieve a single webhook entry by identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Webhook entry identifier |
Example request
GET /api/integration_webhook/get?id=200
X-API-KEY: {your_api_key}/api/integration_webhook/list
Retrieve a paginated list of webhook entries.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset | int | Pagination offset (default: 0) | |
list_condition | object | Filter criteria object |
Example request
GET /api/integration_webhook/list?list_offset=0
X-API-KEY: {your_api_key}/api/integration_webhook/save
Create or modify a webhook entry. On update, only the sended field can be updated. For a new entry use data[id] = 0.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | 0 = new entry, >0 = update (sended update) | |
integration_id | int | Integration identifier | |
integration_webhook_type_id | int | Webhook event type | |
receipt_id | int | Related document identifier | |
receipt_type_id | int | Document type | |
product_id | int | Related product identifier | |
request | string | Content of the request sent (JSON) | |
request_url | string | Request URL | |
response | string | Content of the response received | |
sended | int | 1 = sent (on update) |
Example request
POST /api/integration_webhook/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{
"data": {
"id": 0,
"integration_id": 1,
"integration_webhook_type_id": 3,
"receipt_id": 150,
"receipt_type_id": 2
}
}/api/integration_webhook/delete
Delete a webhook entry by identifier.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the webhook to delete |
Example request
POST /api/integration_webhook/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 200 } }/api/integration_webhook/close
Close a webhook entry — mark it as sent and record the response data.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the webhook to close | |
response | string | Content of the response received | |
response_http_code | string | HTTP status code |
Example request
POST /api/integration_webhook/close
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 200, "response_http_code": "200" } }Create your account now,
pay later!
