List workflow notification channels

List workflow-scoped notification channels.

GET /api/v1/workflows/{workflow_id}/notifications/channels

cURL

curl --request GET \
  --url "${UNSTRUCTURED_API_URL}/api/v1/workflows/f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c/notifications/channels?channel_type=webhook" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"

Response

{
  "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"
    }
  ]
}

Path parameters

workflow_id · string · required

The unique identifier of the workflow.

Query parameters

channel_type · string · required

Channel type to filter by: webhook or email.

For more information, see Webhooks and Email notifications.

enabled · boolean

Filter by enabled status.

Response

items · array · required

List of notification channel objects.

cURL

curl --request GET \
  --url "${UNSTRUCTURED_API_URL}/api/v1/workflows/f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c/notifications/channels?channel_type=webhook" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"

Response

{
  "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"
    }
  ]
}