Update webhook

POST

/merchants/{merchantCode}/webhooks/{webhookId}

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

Update webhook

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

webhookId

required

string

<= 255 characters

Request Body

Media typeapplication/json

object

name

string

<= 255 characters

endpoint

string

<= 255 characters

active

boolean

events

Array<object>

object

code

required

string

Example^generated

{
  "name": "example",
  "endpoint": "example",
  "active": true,
  "events": [
    {
      "code": "example"
    }
  ]
}

Responses

204

Update successful

Media typeapplication/json

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 or Webhook not found

Media typeapplication/json

object

code

required

string

message

required

string

Example

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

409

Sync event already in use

Media typeapplication/json

object

code

required

string

message

required

string

Example

{
  "code": "Conflict",
  "message": "Sync event already in use"
}