> For the complete documentation index, see [llms.txt](https://dev.skladon.com/main/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.skladon.com/main/integration/api/webhooks.md).

# Webhooks

You may find descriptions of endpoints for work with webhooks bellow.

openMore detail of working with webhooks is described here.

## GET /webhooks

> List webhooks

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Webhooks","description":"Webhooks"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"parameters":{"HeaderXApiKey":{"schema":{"type":"string"},"name":"x-api-key","in":"header","required":true,"description":"Eshop API key from onboarding"},"HeaderAuthorization":{"schema":{"type":"string"},"name":"authorization","in":"header","required":true,"description":"Bearer JWT from POST /v21/users/login"}},"schemas":{"V21WebhooksListEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/V21Webhook"}}}},"V21Webhook":{"allOf":[{"$ref":"#/components/schemas/V21CreateWebhook"},{"type":"object","properties":{"id":{"type":"integer"},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}}}]},"V21CreateWebhook":{"type":"object","required":["url","webhookType","active","method"],"properties":{"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/V21WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]}}},"V21WebhookType":{"type":"string","description":"Webhook subscription event. GWMS POSTs a payload to your `url` when this event fires for your eshop.\nValues are fixed uppercase strings (see enum).\n","enum":["CREATE_ORDER","CREATE_PRODUCT","CREATE_RECEIVING","CREATE_RETURN","CREATE_STOCK_MOVEMENT_COMPLETITION","CREATE_STOCK_MOVEMENT_STOCK_CORRECTION","CREATE_STOCK_MOVEMENT_ORDER","CREATE_STOCK_MOVEMENT_RETURN","CREATE_STOCK_MOVEMENT_RECEIVING","CREATE_STOCK_MOVEMENT_QUALITY_HOLD","CREATE_STOCK_MOVEMENT_QUALITY_RELEASE","UPDATE_ORDER","UPDATE_ORDER_STATUS","UPDATE_PRODUCT","UPDATE_RECEIVING","UPDATE_RECEIVING_STATUS","UPDATE_RETURN","UPDATE_RETURN_STATUS"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/webhooks":{"get":{"tags":["Webhooks"],"summary":"List webhooks","operationId":"v21_getWebhooks","parameters":[{"$ref":"#/components/parameters/HeaderXApiKey"},{"$ref":"#/components/parameters/HeaderAuthorization"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21WebhooksListEnvelope"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## POST /webhooks

> Create webhook

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Webhooks","description":"Webhooks"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"parameters":{"HeaderXApiKey":{"schema":{"type":"string"},"name":"x-api-key","in":"header","required":true,"description":"Eshop API key from onboarding"},"HeaderAuthorization":{"schema":{"type":"string"},"name":"authorization","in":"header","required":true,"description":"Bearer JWT from POST /v21/users/login"}},"schemas":{"V21WebhookResponseEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/V21Webhook"}}},"V21Webhook":{"allOf":[{"$ref":"#/components/schemas/V21CreateWebhook"},{"type":"object","properties":{"id":{"type":"integer"},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}}}]},"V21CreateWebhook":{"type":"object","required":["url","webhookType","active","method"],"properties":{"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/V21WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]}}},"V21WebhookType":{"type":"string","description":"Webhook subscription event. GWMS POSTs a payload to your `url` when this event fires for your eshop.\nValues are fixed uppercase strings (see enum).\n","enum":["CREATE_ORDER","CREATE_PRODUCT","CREATE_RECEIVING","CREATE_RETURN","CREATE_STOCK_MOVEMENT_COMPLETITION","CREATE_STOCK_MOVEMENT_STOCK_CORRECTION","CREATE_STOCK_MOVEMENT_ORDER","CREATE_STOCK_MOVEMENT_RETURN","CREATE_STOCK_MOVEMENT_RECEIVING","CREATE_STOCK_MOVEMENT_QUALITY_HOLD","CREATE_STOCK_MOVEMENT_QUALITY_RELEASE","UPDATE_ORDER","UPDATE_ORDER_STATUS","UPDATE_PRODUCT","UPDATE_RECEIVING","UPDATE_RECEIVING_STATUS","UPDATE_RETURN","UPDATE_RETURN_STATUS"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/webhooks":{"post":{"tags":["Webhooks"],"summary":"Create webhook","operationId":"v21_postWebhooks","parameters":[{"$ref":"#/components/parameters/HeaderXApiKey"},{"$ref":"#/components/parameters/HeaderAuthorization"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21WebhookResponseEnvelope"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21CreateWebhook"}}},"required":true}}}}}
```

## GET /webhooks/{id}

> Get webhook detail

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Webhooks","description":"Webhooks"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"V21WebhookResponseEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/V21Webhook"}}},"V21Webhook":{"allOf":[{"$ref":"#/components/schemas/V21CreateWebhook"},{"type":"object","properties":{"id":{"type":"integer"},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}}}]},"V21CreateWebhook":{"type":"object","required":["url","webhookType","active","method"],"properties":{"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/V21WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]}}},"V21WebhookType":{"type":"string","description":"Webhook subscription event. GWMS POSTs a payload to your `url` when this event fires for your eshop.\nValues are fixed uppercase strings (see enum).\n","enum":["CREATE_ORDER","CREATE_PRODUCT","CREATE_RECEIVING","CREATE_RETURN","CREATE_STOCK_MOVEMENT_COMPLETITION","CREATE_STOCK_MOVEMENT_STOCK_CORRECTION","CREATE_STOCK_MOVEMENT_ORDER","CREATE_STOCK_MOVEMENT_RETURN","CREATE_STOCK_MOVEMENT_RECEIVING","CREATE_STOCK_MOVEMENT_QUALITY_HOLD","CREATE_STOCK_MOVEMENT_QUALITY_RELEASE","UPDATE_ORDER","UPDATE_ORDER_STATUS","UPDATE_PRODUCT","UPDATE_RECEIVING","UPDATE_RECEIVING_STATUS","UPDATE_RETURN","UPDATE_RETURN_STATUS"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/webhooks/{id}":{"get":{"tags":["Webhooks"],"summary":"Get webhook detail","operationId":"v21_getWebhook","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21WebhookResponseEnvelope"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## PUT /webhooks/{id}

> Update webhook

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Webhooks","description":"Webhooks"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"V21WebhookResponseEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/V21Webhook"}}},"V21Webhook":{"allOf":[{"$ref":"#/components/schemas/V21CreateWebhook"},{"type":"object","properties":{"id":{"type":"integer"},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}}}]},"V21CreateWebhook":{"type":"object","required":["url","webhookType","active","method"],"properties":{"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/V21WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]}}},"V21WebhookType":{"type":"string","description":"Webhook subscription event. GWMS POSTs a payload to your `url` when this event fires for your eshop.\nValues are fixed uppercase strings (see enum).\n","enum":["CREATE_ORDER","CREATE_PRODUCT","CREATE_RECEIVING","CREATE_RETURN","CREATE_STOCK_MOVEMENT_COMPLETITION","CREATE_STOCK_MOVEMENT_STOCK_CORRECTION","CREATE_STOCK_MOVEMENT_ORDER","CREATE_STOCK_MOVEMENT_RETURN","CREATE_STOCK_MOVEMENT_RECEIVING","CREATE_STOCK_MOVEMENT_QUALITY_HOLD","CREATE_STOCK_MOVEMENT_QUALITY_RELEASE","UPDATE_ORDER","UPDATE_ORDER_STATUS","UPDATE_PRODUCT","UPDATE_RECEIVING","UPDATE_RECEIVING_STATUS","UPDATE_RETURN","UPDATE_RETURN_STATUS"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/webhooks/{id}":{"put":{"tags":["Webhooks"],"summary":"Update webhook","operationId":"v21_putWebhook","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21WebhookResponseEnvelope"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21CreateWebhook"}}},"required":true}}}}}
```

## PUT /webhooks/{id}/deactivate

> Deactivate webhook

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Webhooks","description":"Webhooks"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"parameters":{"HeaderXApiKey":{"schema":{"type":"string"},"name":"x-api-key","in":"header","required":true,"description":"Eshop API key from onboarding"},"HeaderAuthorization":{"schema":{"type":"string"},"name":"authorization","in":"header","required":true,"description":"Bearer JWT from POST /v21/users/login"}},"schemas":{"V21WebhookResponseEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/V21Webhook"}}},"V21Webhook":{"allOf":[{"$ref":"#/components/schemas/V21CreateWebhook"},{"type":"object","properties":{"id":{"type":"integer"},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}}}]},"V21CreateWebhook":{"type":"object","required":["url","webhookType","active","method"],"properties":{"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/V21WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]}}},"V21WebhookType":{"type":"string","description":"Webhook subscription event. GWMS POSTs a payload to your `url` when this event fires for your eshop.\nValues are fixed uppercase strings (see enum).\n","enum":["CREATE_ORDER","CREATE_PRODUCT","CREATE_RECEIVING","CREATE_RETURN","CREATE_STOCK_MOVEMENT_COMPLETITION","CREATE_STOCK_MOVEMENT_STOCK_CORRECTION","CREATE_STOCK_MOVEMENT_ORDER","CREATE_STOCK_MOVEMENT_RETURN","CREATE_STOCK_MOVEMENT_RECEIVING","CREATE_STOCK_MOVEMENT_QUALITY_HOLD","CREATE_STOCK_MOVEMENT_QUALITY_RELEASE","UPDATE_ORDER","UPDATE_ORDER_STATUS","UPDATE_PRODUCT","UPDATE_RECEIVING","UPDATE_RECEIVING_STATUS","UPDATE_RETURN","UPDATE_RETURN_STATUS"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/webhooks/{id}/deactivate":{"put":{"tags":["Webhooks"],"summary":"Deactivate webhook","operationId":"v21_putWebhookDeactivate","parameters":[{"$ref":"#/components/parameters/HeaderXApiKey"},{"$ref":"#/components/parameters/HeaderAuthorization"},{"schema":{"type":"integer"},"name":"id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21WebhookResponseEnvelope"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## PUT /webhooks/{id}/activate

> Activate webhook

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Webhooks","description":"Webhooks"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"parameters":{"HeaderXApiKey":{"schema":{"type":"string"},"name":"x-api-key","in":"header","required":true,"description":"Eshop API key from onboarding"},"HeaderAuthorization":{"schema":{"type":"string"},"name":"authorization","in":"header","required":true,"description":"Bearer JWT from POST /v21/users/login"}},"schemas":{"V21WebhookResponseEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/V21Webhook"}}},"V21Webhook":{"allOf":[{"$ref":"#/components/schemas/V21CreateWebhook"},{"type":"object","properties":{"id":{"type":"integer"},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}}}]},"V21CreateWebhook":{"type":"object","required":["url","webhookType","active","method"],"properties":{"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/V21WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]}}},"V21WebhookType":{"type":"string","description":"Webhook subscription event. GWMS POSTs a payload to your `url` when this event fires for your eshop.\nValues are fixed uppercase strings (see enum).\n","enum":["CREATE_ORDER","CREATE_PRODUCT","CREATE_RECEIVING","CREATE_RETURN","CREATE_STOCK_MOVEMENT_COMPLETITION","CREATE_STOCK_MOVEMENT_STOCK_CORRECTION","CREATE_STOCK_MOVEMENT_ORDER","CREATE_STOCK_MOVEMENT_RETURN","CREATE_STOCK_MOVEMENT_RECEIVING","CREATE_STOCK_MOVEMENT_QUALITY_HOLD","CREATE_STOCK_MOVEMENT_QUALITY_RELEASE","UPDATE_ORDER","UPDATE_ORDER_STATUS","UPDATE_PRODUCT","UPDATE_RECEIVING","UPDATE_RECEIVING_STATUS","UPDATE_RETURN","UPDATE_RETURN_STATUS"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/webhooks/{id}/activate":{"put":{"tags":["Webhooks"],"summary":"Activate webhook","operationId":"v21_putWebhookActivate","parameters":[{"$ref":"#/components/parameters/HeaderXApiKey"},{"$ref":"#/components/parameters/HeaderAuthorization"},{"schema":{"type":"integer"},"name":"id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21WebhookResponseEnvelope"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## DELETE /webhooks/{id}

> Delete webhook

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Webhooks","description":"Webhooks"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"V21StringDataEnvelope":{"type":"object","description":"Generic success envelope where `data` is a plain string (e.g. base64 file content).","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"string"}}},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/webhooks/{id}":{"delete":{"tags":["Webhooks"],"summary":"Delete webhook","operationId":"v21_deleteWebhook","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21StringDataEnvelope"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

{% content-ref url="/pages/1Tgb0iQWf4Z1q7cOswOz" %}
[Webhooks](/main/integration/webhooks.md)
{% endcontent-ref %}