Skip to main content

​
List Notification Channels

Returns all notification channels registered for a dock. 
GET /v1/docks/:dockId/notification-channels

​
Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID

​
Example Request

curl https://api.docyard.io/v1/docks/dock_01HQ3K.../notification-channels \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

​
Response

[
  {
    "id": "nch_01HQ7A...",
    "dockId": "dock_01HQ3K...",
    "type": "webhook",
    "endpoint": "https://hooks.acme-insurance.com/docyard/notifications"
  },
  {
    "id": "nch_01HQ7B...",
    "dockId": "dock_01HQ3K...",
    "type": "email",
    "endpoint": "[email protected]"
  },
  {
    "id": "nch_01HQ7C...",
    "dockId": "dock_01HQ3K...",
    "type": "sms",
    "endpoint": "+15551234567"
  }
]

​
Error Handling

StatusCondition
401Missing or invalid API key
404Dock not found