Get subscription

get /v1/{tenantName}/webhook

Gets all the subscribed webhooks.

tenantName

string

required

The name of the tenant.

id[]

array[string]

required

string

event[]

array[string]

required

string

Available webhook events.

  • "kyc_changed": User KYC status has changed.
Enum
  • kyc_changed

Response

Examples Schema

Successful operation

[
  {
    "event": "kyc_changed",
    "id": 123.0,
    "url": "string"
  }
]

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

array[object]

object

event

string

Available webhook events.

  • "kyc_changed": User KYC status has changed.
Enum
  • kyc_changed

id

number

url

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Add subcription

post /v1/{tenantName}/webhook

Add a new webhook subscription.

tenantName

string

required

The name of the tenant.

event

string

Available webhook events.

  • "kyc_changed": User KYC status has changed.
Enum
  • kyc_changed

url

string

Request

{
  "event": "kyc_changed",
  "url": "string"
}

Response

Examples Schema

Successful operation

{
  "id": 123.0
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

id

number

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Delete subcription

delete /v1/{tenantName}/webhook

Delete a webhook subscription

tenantName

string

required

The name of the tenant.

id[]

array[string]

required

string

event[]

array[string]

required

string

Available webhook events.

  • "kyc_changed": User KYC status has changed.
Enum
  • kyc_changed

Response

Examples Schema

Successful operation

{
  "success": true
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

success

boolean

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Was this page helpful?