Get notification channel

Get workspace-scoped notification channel by ID.

GET /api/v1/notifications/channels/{channel_id}

cURL

curl --request GET \
  --url "${UNSTRUCTURED_API_URL}/api/v1/notifications/channels/c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"

Response

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

channel_id · string · required

The unique identifier of the notification channel.

Response

id · string · required

Unique identifier for the channel.

channel_type · string · required

Channel type: webhook or email.

For more information, see Webhooks and Email notifications.

event_types · array · required

Subscribed event types.

enabled · boolean · required

Whether the channel is active.

created_at · string · required

ISO 8601 timestamp when the channel was created.

updated_at · string · required

ISO 8601 timestamp when the channel was last updated.

description · string

Channel description.

url · string

Webhook endpoint URL. Present when channel_type is webhook.

email_config · object

Email delivery configuration. Present when channel_type is email.

cURL

curl --request GET \
  --url "${UNSTRUCTURED_API_URL}/api/v1/notifications/channels/c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"

Response

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