Update the subscription to redirect session events

PATCH 
/redirect-session-events/subscriptions/:eventSubscriptionId

Update the subscription to redirect session events

Request

Path Parameters

eventSubscriptionId stringrequired

The unique id of this subscription, which can be used for unsubscribing later on.

application/json

Body

required

callbackUrl urirequired

callback url that will be called by server for every subscribed event

apiKey stringrequired

Possible values: Value must match regular expression ^[A-z0-9=+\/\-:_]{1,128}$

Sent back in the x-api-key header of the callback

eventTypes RedirectSessionEventType (string)[]required

Possible values: [RedirectSessionCancelled], >= 1

the list of event types to which subscriber would like to listen for

Responses

200

Webhook updated

application/json

Schema

Schema

id uuidrequired

Unique id of the subscription

callbackUrl urirequired

callback url that will be called by server for every subscribed event

eventTypes RedirectSessionEventType (string)[]

Possible values: [RedirectSessionCancelled]

Example (from schema)

{
  "id": "6d245f63-fdfc-4a6b-a351-bc0b03260dcd",
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventTypes": [
    "RedirectSessionCancelled"
  ]
}

400

Validation failed

application/json

Schema

Schema

code stringrequired

Possible values: [Validation]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "Validation",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

403

Operation forbidden

application/json

Schema

Schema

code stringrequired

Possible values: [InvalidTriggeredBy]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "InvalidTriggeredBy",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

404

Subscription not found

application/json

Schema

Schema

code stringrequired

Possible values: [SubscriptionNotFound]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "SubscriptionNotFound",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

409

Subscription was updated in the meantime, get and retry

application/json

Schema

Schema

code stringrequired

Possible values: [EntityVersionMismatch, DuplicateEntity]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "EntityVersionMismatch",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

500

Unexpected technical error

application/json

Schema

Schema

code stringrequired

Possible values: [GeneralErrorOccurred]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "GeneralErrorOccurred",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

Loading...