Update the subscription to Customer events
PATCH/customer-events/subscriptions/:eventSubscriptionId
Update the subscription to Customer events
Request
Path Parameters
The unique id of this subscription, which can be used for unsubscribing later on.
- application/json
Body
required
callback url that will be called by server for every subscribed event
Possible values: Value must match regular expression ^[A-z0-9=+\/\-:_]{1,128}$
Sent back in the x-api-key header of the callback
Possible values: [CustomerRegistered
], >= 1
the list of event types to which subscriber would like to listen for
Responses
- 200
- 400
- 403
- 404
- 409
- 500
Webhook updated
- application/json
- Schema
- Example (from schema)
Schema
Unique id of the subscription
callback url that will be called by server for every subscribed event
Possible values: [CustomerRegistered
]
{
"id": "6d245f63-fdfc-4a6b-a351-bc0b03260dcd",
"callbackUrl": "https://myserver.com/send/callback/here",
"eventTypes": [
"CustomerRegistered"
]
}
Validation failed
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [Validation
]
The type of error
A short text describing the error
A link to the online documentation describing the error in detail
Identifies the conversation within which the error got generated
details
object
Contains additional details of the error
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
{
"code": "Validation",
"message": "string",
"moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
]
}
}
Operation forbidden
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [InvalidTriggeredBy
]
The type of error
A short text describing the error
A link to the online documentation describing the error in detail
Identifies the conversation within which the error got generated
details
object
Contains additional details of the error
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
{
"code": "InvalidTriggeredBy",
"message": "string",
"moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
]
}
}
Subscription not found
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [SubscriptionNotFound
]
The type of error
A short text describing the error
A link to the online documentation describing the error in detail
Identifies the conversation within which the error got generated
details
object
Contains additional details of the error
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
{
"code": "SubscriptionNotFound",
"message": "string",
"moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
]
}
}
Subscription was updated in the meantime, get and retry
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [DuplicateEntity
, EntityVersionMismatch
]
The type of error
A short text describing the error
A link to the online documentation describing the error in detail
Identifies the conversation within which the error got generated
details
object
Contains additional details of the error
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
{
"code": "DuplicateEntity",
"message": "string",
"moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
]
}
}
Unexpected technical error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [GeneralErrorOccurred
]
The type of error
A short text describing the error
A link to the online documentation describing the error in detail
Identifies the conversation within which the error got generated
details
object
Contains additional details of the error
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
{
"code": "GeneralErrorOccurred",
"message": "string",
"moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
]
}
}