Skip to content

createChannel

Request

Path
domainIdstringrequired
Bodyapplication/jsonrequired
One of:
idstring, (uuid)required
namestringrequired
supportedEventTypesArray of stringsrequired
statusstring
Enum:"ACTIVE""DISABLED"
maxRetriesinteger, (int32)
createdBystring, (uuid)required
typestringrequired
Value:"WEBHOOK"
Discriminator
urlstringrequired
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/domains/{domainId}/channels' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "supportedEventTypes": [
      "string"
    ],
    "status": "ACTIVE",
    "maxRetries": 0,
    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
    "type": "WEBHOOK",
    "url": "string"
  }'

Responses

OK

Body*/*
idstring, (uuid)
domainIdstring, (uuid)
namestring
supportedEventTypesArray of strings
typestring
Value:"WEBHOOK"
statusstring
Enum:"ACTIVE""DISABLED"
maxRetriesinteger, (int32)
urlstring
createdBystring, (uuid)
lastUpdatedBystring, (uuid)
createdAtstring, (date-time)
lastUpdatedAtstring, (date-time)
errorRatenumber, (double)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",
  "name": "string",
  "supportedEventTypes": [
    "string"
  ],
  "type": "WEBHOOK",
  "status": "ACTIVE",
  "maxRetries": 0,
  "url": "string",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  "lastUpdatedBy": "9eca4444-bb39-4c34-8088-e204f5c15d34",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "errorRate": 0.1
}