Webhooks

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

Get all webhooks

get

Authorizations

authorization & XApiKey

authorizationstringRequired

x-api-keystringRequired

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

/webhooks

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Create webhook

post

Authorizations

authorization & XApiKey

authorizationstringRequired

x-api-keystringRequired

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body

application/json

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

/webhooks

HTTPcURLJavaScriptPython

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

authorization & XApiKey

authorizationstringRequired

x-api-keystringRequired

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

application/json

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

/webhooks/{id}

HTTPcURLJavaScriptPython

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"
  }
}

Get webhook

get

Authorizations

authorization & XApiKey

authorizationstringRequired

x-api-keystringRequired

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

/webhooks/{id}

HTTPcURLJavaScriptPython

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

authorization & XApiKey

authorizationstringRequired

x-api-keystringRequired

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

/webhooks/{id}/activate

HTTPcURLJavaScriptPython

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

authorization & XApiKey

authorizationstringRequired

x-api-keystringRequired

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

/webhooks/{id}/deactivate

HTTPcURLJavaScriptPython

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

authorization & XApiKey

authorizationstringRequired

x-api-keystringRequired

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

delete

/webhooks/{id}

HTTPcURLJavaScriptPython

DELETE /v2/webhooks/{id} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

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

More detail of working with webhooks is described here.

Webhooks