curl --request GET \
--url "${UNSTRUCTURED_API_URL}/api/v1/notifications/channels?channel_type=webhook" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"
{
"items": [
{
"id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
"channel_type": "webhook",
"description": "Job status alerts",
"event_types": ["job.completed", "job.failed"],
"enabled": true,
"url": "https://hooks.example.com/notify",
"created_at": "2026-04-29T10:00:00Z",
"updated_at": "2026-04-29T10:00:00Z"
}
]
}
Notification
List notification channels
List workspace-scoped notification channels.
GET
/
api
/
v1
/
notifications
/
channels
curl --request GET \
--url "${UNSTRUCTURED_API_URL}/api/v1/notifications/channels?channel_type=webhook" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"
{
"items": [
{
"id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
"channel_type": "webhook",
"description": "Job status alerts",
"event_types": ["job.completed", "job.failed"],
"enabled": true,
"url": "https://hooks.example.com/notify",
"created_at": "2026-04-29T10:00:00Z",
"updated_at": "2026-04-29T10:00:00Z"
}
]
}
Query parameters
string
required
Channel type to filter by:
webhook or email.For more information, see Webhooks and Email notifications.boolean
Filter by enabled status.
Response
array
required
List of notification channel objects.
curl --request GET \
--url "${UNSTRUCTURED_API_URL}/api/v1/notifications/channels?channel_type=webhook" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"
{
"items": [
{
"id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
"channel_type": "webhook",
"description": "Job status alerts",
"event_types": ["job.completed", "job.failed"],
"enabled": true,
"url": "https://hooks.example.com/notify",
"created_at": "2026-04-29T10:00:00Z",
"updated_at": "2026-04-29T10:00:00Z"
}
]
}
Was this page helpful?