Create webhooks

POST

/merchants/{merchantCode}/webhooks

curl --request POST \
  --url https://webhook.shopgate.io/v1/merchants/example/webhooks \
  --header 'Content-Type: application/json' \
  --data '{ "webhooks": [ { "code": "string", "name": "example", "endpoint": "example", "active": true, "events": [ { "code": "example" } ] } ] }'

Register new webhooks

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

Request Body

The following event codes are supported:

• cartReminderTimeReached
• customerDeleted
• fulfillmentOrderAdded
• fulfillmentOrderStatusUpdated
• fulfillmentOrderUpdated
• importCompleted
• inventoryReservationCreated
• inventoryReservationUpdated
• inventoryReservationDeleted
• inventoryReservationSettled
• locationCreated
• locationDeleted
• locationUpdated
• orderNotPickedUp
• productCreated
• productUpdated
• salesOrderAdded
• salesOrderFulfillmentAdded
• salesOrderStatusUpdated
• salesOrderUpdated
• returnOrderAdded
• returnOrderStatusUpdated
• schedulePickTimeReached
• schedulePickupReminderTimeReached

Media typeapplication/json

object

webhooks

required

Array<object>

>= 1 items

object

code

string | null

<= 255 characters

Example

string

name

required

string

<= 255 characters

endpoint

required

string

<= 255 characters

active

required

boolean

events

required

Array<object>

object

code

required

string

Responses

200

Invalid request

Media typeapplication/json

object

errors

Array<object>

object

code

number

entity

string

entityId

string

entityIndex

number

reason

string

subentityPath

Array<number | string>

ids

Array<string>

Example

{
  "errors": [
    {
      "code": 409,
      "entity": "webhook",
      "entityId": "salesOrderAddedMagento",
      "entityIndex": 0,
      "reason": "Webhook with code 'salesOrderAddedMagento' already exists",
      "subentityPath": []
    }
  ],
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

400

Validation error

Media typeapplication/json

object

message

string

code

string

error

object

paramName

The parameter-field, that failed to validate, like “userId”

string

paramValue

The value, that was sent, like “xxx”

null | string | number | object | array

code

Machine readable error code

string

Allowed values: SCHEMA_VALIDATION_FAILED ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT UNKNOWN_FORMAT PATTERN

message

required

Human readable error code

string

results

object

errors

Array<object>

object

code

Machine readable error code

string

Allowed values: ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT UNKNOWN_FORMAT PATTERN

message

Human readable error code

string

description

string

path

Array<string>

warnings

Array<object>

object

code

Machine readable error code

string

Allowed values: ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT UNKNOWN_FORMAT PATTERN

message

Human readable error code

string

description

string

path

Array<string>

Example

{
  "error": {
    "code": "SCHEMA_VALIDATION_FAILED",
    "results": {
      "errors": [
        {
          "code": "ENUM_MISMATCH",
          "description": "human readable error code"
        }
      ],
      "warnings": [
        {
          "code": "ENUM_MISMATCH",
          "description": "human readable error code"
        }
      ]
    }
  }
}

404

Merchant not found

Media typeapplication/json

object

code

required

string

message

required

string

Example

{
  "code": "NotFound",
  "message": "Merchant not found"
}