Update webhook

PATCH 
/webhooks/:id

Updates the webhook configuration.

Request

Path Parameters

id stringrequired

The ID of the webhook to update

application/json

Body

required

Webhook update data

name string
subscribedEventTypes string[]

Possible values: [WEBHOOK_CREATED, WEBHOOK_UPDATED, CUSTOMER_CREATED, DEPOSIT_TRANSACTION_INITIALIZED, DEPOSIT_TRANSACTION_FAILED, DEPOSIT_TRANSACTION_SUCCEEDED, WITHDRAW_TRANSACTION_INITIALIZED, WITHDRAW_TRANSACTION_FAILED, WITHDRAW_TRANSACTION_SUCCEEDED, INTERNAL_TRANSACTION_INITIALIZED, VIRTUAL_INTERNAL_TRANSACTION_SUCCEEDED, VIRTUAL_ACCOUNT_CREATED, ASSET_TRADE_SUCCESSFUL, ASSET_TRADE_FAIL, LTV_LIQUIDATED, LTV_LIQUIDATION_WARNING, LTV_URGENT_COLLATERAL_NEEDED, LTV_COLLATERAL_NEEDED, LTV_PURCHASE_RESTRICTED, LTV_THRESHOLD_WARNING, MEMBERSHIP_CONFIRMATION]

url string
active boolean

Responses

200

Webhook was successfully updated.

application/json

Schema

Schema

traceId string
message string

data

object

id stringrequired

name stringrequired

subscribedEventTypes string[]required

Possible values: [WEBHOOK_CREATED, WEBHOOK_UPDATED, CUSTOMER_CREATED, DEPOSIT_TRANSACTION_INITIALIZED, DEPOSIT_TRANSACTION_FAILED, DEPOSIT_TRANSACTION_SUCCEEDED, WITHDRAW_TRANSACTION_INITIALIZED, WITHDRAW_TRANSACTION_FAILED, WITHDRAW_TRANSACTION_SUCCEEDED, INTERNAL_TRANSACTION_INITIALIZED, VIRTUAL_INTERNAL_TRANSACTION_SUCCEEDED, VIRTUAL_ACCOUNT_CREATED, ASSET_TRADE_SUCCESSFUL, ASSET_TRADE_FAIL, LTV_LIQUIDATED, LTV_LIQUIDATION_WARNING, LTV_URGENT_COLLATERAL_NEEDED, LTV_COLLATERAL_NEEDED, LTV_PURCHASE_RESTRICTED, LTV_THRESHOLD_WARNING, MEMBERSHIP_CONFIRMATION]

active booleanrequired

url stringrequired

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": {
    "id": "string",
    "name": "string",
    "subscribedEventTypes": [
      "WEBHOOK_CREATED"
    ],
    "active": true,
    "url": "string"
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...