Skladon - Developers
  • Skladon docs
  • 馃摗Integration
    • API
      • API usage tips and limits
      • Authentication
      • Claims
      • Files
      • Orders
      • Products
      • Products availability
      • Products sets
      • Receivings
      • Returns
      • Shipper service codes
      • Webhooks
      • Stock movements
    • Webhooks
  • Report a Bug
Powered by GitBook
On this page
  1. Integration
  2. API

Webhooks

PreviousShipper service codesNextStock movements

Last updated 1 month ago

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

More detail of working with webhooks is described here.

馃摗
Webhooks

Get webhook

get
Authorizations
Path parameters
idnumber 路 min: 1Required
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
get
GET /v2/webhooks/{id} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "url": "https//api.domain.net/receiving/eshopReceivingId",
    "webhookType": "UPDATE_RECEIVING",
    "active": true,
    "method": "POST",
    "registeredAt": "2022-04-08T09:19:05.000Z",
    "unregisteredAt": "text"
  }
}

Activate webhook

put
Authorizations
Path parameters
idnumber 路 min: 1Required
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
put
PUT /v2/webhooks/{id}/activate HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "url": "https//api.domain.net/receiving/eshopReceivingId",
    "webhookType": "UPDATE_RECEIVING",
    "active": true,
    "method": "POST",
    "registeredAt": "2022-04-08T09:19:05.000Z",
    "unregisteredAt": "text"
  }
}

Deactivate webhook

put
Authorizations
Path parameters
idnumber 路 min: 1Required
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
put
PUT /v2/webhooks/{id}/deactivate HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "url": "https//api.domain.net/receiving/eshopReceivingId",
    "webhookType": "UPDATE_RECEIVING",
    "active": true,
    "method": "POST",
    "registeredAt": "2022-04-08T09:19:05.000Z",
    "unregisteredAt": "text"
  }
}

Delete webhook

delete
Authorizations
Path parameters
idnumber 路 min: 1Required
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
objectOptional

Payload is not allowed for DELETE requests

Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
delete
DELETE /v2/webhooks/{id} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "statusCode": 1,
  "message": "text",
  "data": "text"
}

Get all webhooks

get
Authorizations
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Responses
200
Success response
application/json
401
Unauthorized response
application/json
get
GET /v2/webhooks HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

{
  "statusCode": 200,
  "message": "text",
  "data": [
    {
      "id": 1,
      "url": "https//api.domain.net/receiving/eshopReceivingId",
      "webhookType": "UPDATE_RECEIVING",
      "active": true,
      "method": "POST",
      "registeredAt": "2022-04-08T09:19:05.000Z",
      "unregisteredAt": "text"
    }
  ]
}
  • GETGet all webhooks
  • POSTCreate webhook
  • PUTUpdate webhook
  • GETGet webhook
  • PUTActivate webhook
  • PUTDeactivate webhook
  • DELETEDelete webhook

Create webhook

post
Authorizations
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
urlstring 路 min: 1RequiredExample: https//api.domain.net/receiving/eshopReceivingId
webhookTypestring 路 enumRequired

Type of webhook

Example: UPDATE_RECEIVINGPossible values:
activebooleanRequiredExample: true
methodstring 路 enumRequiredExample: POSTPossible values:
Responses
200
Success response
application/json
401
Unauthorized response
application/json
post
POST /v2/webhooks HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "url": "https//api.domain.net/receiving/eshopReceivingId",
  "webhookType": "UPDATE_RECEIVING",
  "active": true,
  "method": "POST"
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "url": "https//api.domain.net/receiving/eshopReceivingId",
    "webhookType": "UPDATE_RECEIVING",
    "active": true,
    "method": "POST",
    "registeredAt": "2022-04-08T09:19:05.000Z",
    "unregisteredAt": "text"
  }
}

Update webhook

put
Authorizations
Path parameters
idnumber 路 min: 1Required
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
urlstring 路 min: 1RequiredExample: https//api.domain.net/receiving/eshopReceivingId
webhookTypestring 路 enumRequired

Type of webhook

Example: UPDATE_RECEIVINGPossible values:
activebooleanRequiredExample: true
methodstring 路 enumRequiredExample: POSTPossible values:
Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
put
PUT /v2/webhooks/{id} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "url": "https//api.domain.net/receiving/eshopReceivingId",
  "webhookType": "UPDATE_RECEIVING",
  "active": true,
  "method": "POST"
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "url": "https//api.domain.net/receiving/eshopReceivingId",
    "webhookType": "UPDATE_RECEIVING",
    "active": true,
    "method": "POST",
    "registeredAt": "2022-04-08T09:19:05.000Z",
    "unregisteredAt": "text"
  }
}