# Webhooks

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

## GET /webhooks

> Get all webhooks

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"WebhooksResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/Webhooks"}},"required":["statusCode","message"]},"Webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"Webhook":{"type":"object","properties":{"id":{"type":"number"},"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}},"required":["url","webhookType","active","method"]},"WebhookType":{"type":"string","description":"Type of webhook","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":{"summary":"Get all webhooks","operationId":"getWebhooks","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true}],"tags":["Webhooks"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhooksResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## POST /webhooks

> Create webhook

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"WebhookResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/Webhook"}},"required":["statusCode","message"]},"Webhook":{"type":"object","properties":{"id":{"type":"number"},"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}},"required":["url","webhookType","active","method"]},"WebhookType":{"type":"string","description":"Type of webhook","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"]},"CreateWebhook":{"type":"object","properties":{"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]}},"required":["url","webhookType","active","method"]}}},"paths":{"/webhooks":{"post":{"summary":"Create webhook","operationId":"postWebhooks","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true}],"tags":["Webhooks"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhook"}}}}}}}}
```

## PUT /webhooks/{id}

> Update webhook

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"WebhookResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/Webhook"}},"required":["statusCode","message"]},"Webhook":{"type":"object","properties":{"id":{"type":"number"},"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}},"required":["url","webhookType","active","method"]},"WebhookType":{"type":"string","description":"Type of webhook","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"]},"CreateWebhook":{"type":"object","properties":{"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]}},"required":["url","webhookType","active","method"]}}},"paths":{"/webhooks/{id}":{"put":{"summary":"Update webhook","operationId":"putWebhooksId","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true},{"schema":{"type":"number","minimum":1},"name":"id","in":"path","required":true}],"tags":["Webhooks"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhook"}}}}}}}}
```

## GET /webhooks/{id}

> Get webhook

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"WebhookResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/Webhook"}},"required":["statusCode","message"]},"Webhook":{"type":"object","properties":{"id":{"type":"number"},"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}},"required":["url","webhookType","active","method"]},"WebhookType":{"type":"string","description":"Type of webhook","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":{"summary":"Get webhook","operationId":"getWebhooksId","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true},{"schema":{"type":"number","minimum":1},"name":"id","in":"path","required":true}],"tags":["Webhooks"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## PUT /webhooks/{id}/activate

> Activate webhook

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"WebhookResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/Webhook"}},"required":["statusCode","message"]},"Webhook":{"type":"object","properties":{"id":{"type":"number"},"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}},"required":["url","webhookType","active","method"]},"WebhookType":{"type":"string","description":"Type of webhook","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":{"summary":"Activate webhook","operationId":"putWebhooksIdActivate","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true},{"schema":{"type":"number","minimum":1},"name":"id","in":"path","required":true}],"tags":["Webhooks"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## PUT /webhooks/{id}/deactivate

> Deactivate webhook

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"WebhookResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/Webhook"}},"required":["statusCode","message"]},"Webhook":{"type":"object","properties":{"id":{"type":"number"},"url":{"type":"string","minLength":1},"webhookType":{"$ref":"#/components/schemas/WebhookType"},"active":{"type":"boolean"},"method":{"type":"string","enum":["POST","GET"]},"registeredAt":{"type":"string"},"unregisteredAt":{"type":"string"}},"required":["url","webhookType","active","method"]},"WebhookType":{"type":"string","description":"Type of webhook","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":{"summary":"Deactivate webhook","operationId":"putWebhooksIdDeactivate","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true},{"schema":{"type":"number","minimum":1},"name":"id","in":"path","required":true}],"tags":["Webhooks"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## DELETE /webhooks/{id}

> Delete webhook

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"Model42":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"string"}},"required":["statusCode","message","data"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/webhooks/{id}":{"delete":{"summary":"Delete webhook","operationId":"deleteWebhooksId","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true},{"schema":{"type":"number","minimum":1},"name":"id","in":"path","required":true}],"tags":["Webhooks"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model42"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

More detail of working with webhooks is described here.

{% content-ref url="../webhooks" %}
[webhooks](https://dev.skladon.com/main/integration/webhooks)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dev.skladon.com/main/integration/api/webhooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.