From 8f951f05d848f5b89783f8195f0b9719636caca8 Mon Sep 17 00:00:00 2001 From: Andrew May Date: Fri, 12 Jun 2026 10:25:00 -0700 Subject: [PATCH] Add email and webhook Postman collections. --- ...mail-notifications.postman_collection.json | 467 ++++++++++++++++ ...tructured-webhooks.postman_collection.json | 506 ++++++++++++++++++ 2 files changed, 973 insertions(+) create mode 100644 postman/unstructured-email-notifications.postman_collection.json create mode 100644 postman/unstructured-webhooks.postman_collection.json diff --git a/postman/unstructured-email-notifications.postman_collection.json b/postman/unstructured-email-notifications.postman_collection.json new file mode 100644 index 0000000..521e47d --- /dev/null +++ b/postman/unstructured-email-notifications.postman_collection.json @@ -0,0 +1,467 @@ +{ + "info": { + "_postman_id": "0a713949-7f22-4dd0-ba10-11ad89308c91", + "name": "Unstructured Email Notifications", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Workspace-scoped channels", + "item": [ + { + "name": "1. Create an email channel", + "request": { + "method": "POST", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Specify the settings for the workspace email notification channel here.\n // See https://docs.unstructured.io/api-reference/email\n // API reference: https://docs.unstructured.io/api-reference/api/notification/create-notification-channel\n \"channel_type\": \"email\",\n \"event_types\": [\"job.scheduled\", \"job.in_progress\", \"job.completed\", \"job.stopped\", \"job.failed\"],\n \"description\": \"Workspace level job events\",\n \"email_config\": {\n \"recipient_email\": \"donotreply@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels" + ] + }, + "description": "Create a workspace-scoped email notification channel that sends emails when the specified job events occur across all workflows in the workspace. The response includes the channel ID needed to verify the channel. See https://docs.unstructured.io/api-reference/email" + }, + "response": [] + }, + { + "name": "2. Verify an email channel", + "request": { + "method": "POST", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Enter the 6-digit verification code sent to the recipient email address.\n // See https://docs.unstructured.io/api-reference/email#verify-the-email-channel\n // API reference: https://docs.unstructured.io/api-reference/api/notification/verify-notification-channel\n \"verification_code\": \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels//verify", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels", + "", + "verify" + ] + }, + "description": "Verify a workspace-scoped email channel using the 6-digit code sent to the recipient address at channel creation. A 204 No Content response indicates the channel is now active. See https://docs.unstructured.io/api-reference/email#verify-the-email-channel" + }, + "response": [] + }, + { + "name": "Get an email channel", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels", + "" + ] + }, + "description": "Get a workspace-scoped notification channel by ID. See https://docs.unstructured.io/api-reference/api/notification/get-notification-channel" + }, + "response": [] + }, + { + "name": "Update an email channel", + "request": { + "method": "PATCH", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Specify the fields to update for the workspace email notification channel here.\n // See https://docs.unstructured.io/api-reference/email\n // API reference: https://docs.unstructured.io/api-reference/api/notification/update-notification-channel\n \"event_types\": [\"job.scheduled\", \"job.in_progress\", \"job.completed\", \"job.stopped\", \"job.failed\"],\n \"email_config\": {\n \"recipient_email\": \"donotreply@example.com\"\n },\n \"enabled\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels", + "" + ] + }, + "description": "Update a workspace-scoped email notification channel; only provided fields are changed. The channel must be verified before it can be updated. See https://docs.unstructured.io/api-reference/api/notification/update-notification-channel" + }, + "response": [] + }, + { + "name": "Delete an email channel", + "request": { + "method": "DELETE", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels", + "" + ] + }, + "description": "Permanently delete a workspace-scoped notification channel. This action is not recoverable. See https://docs.unstructured.io/api-reference/api/notification/delete-notification-channel" + }, + "response": [] + }, + { + "name": "List email channels", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels?channel_type=email", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels" + ], + "query": [ + { + "key": "channel_type", + "value": "email" + } + ] + }, + "description": "List all workspace-scoped email notification channels. See https://docs.unstructured.io/api-reference/api/notification/list-notification-channels" + }, + "response": [] + } + ] + }, + { + "name": "Workflow-scoped channels", + "item": [ + { + "name": "1. Create a workflow email channel", + "request": { + "method": "POST", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Specify the settings for the workflow email notification channel here.\n // See https://docs.unstructured.io/api-reference/email\n // API reference: https://docs.unstructured.io/api-reference/api/workflow/create-workflow-notification-channel\n \"channel_type\": \"email\",\n \"event_types\": [\"job.scheduled\", \"job.in_progress\", \"job.completed\", \"job.stopped\", \"job.failed\"],\n \"description\": \"Workflow-specific status alerts\",\n \"email_config\": {\n \"recipient_email\": \"donotreply@example.com\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels" + ] + }, + "description": "Create an email notification channel scoped to a single workflow that sends emails when the specified job events occur for that workflow's jobs. The response includes the channel ID needed to verify the channel. See https://docs.unstructured.io/api-reference/email" + }, + "response": [] + }, + { + "name": "2. Verify a workflow email channel", + "request": { + "method": "POST", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Enter the 6-digit verification code sent to the recipient email address.\n // See https://docs.unstructured.io/api-reference/email#verify-the-email-channel\n // API reference: https://docs.unstructured.io/api-reference/api/workflow/verify-workflow-notification-channel\n \"verification_code\": \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels//verify", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels", + "", + "verify" + ] + }, + "description": "Verify a workflow-scoped email channel using the 6-digit code sent to the recipient address at channel creation. A 204 No Content response indicates the channel is now active. See https://docs.unstructured.io/api-reference/email#verify-the-email-channel" + }, + "response": [] + }, + { + "name": "Get a workflow email channel", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels", + "" + ] + }, + "description": "Get a workflow-scoped notification channel by ID. See https://docs.unstructured.io/api-reference/api/workflow/get-workflow-notification-channel" + }, + "response": [] + }, + { + "name": "Update a workflow email channel", + "request": { + "method": "PATCH", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Specify the fields to update for the workflow email notification channel here.\n // See https://docs.unstructured.io/api-reference/email\n // API reference: https://docs.unstructured.io/api-reference/api/workflow/update-workflow-notification-channel\n \"event_types\": [\"job.scheduled\", \"job.in_progress\", \"job.completed\", \"job.stopped\", \"job.failed\"],\n \"email_config\": {\n \"recipient_email\": \"donotreply@example.com\"\n },\n \"enabled\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels", + "" + ] + }, + "description": "Update a workflow-scoped email notification channel; only provided fields are changed. The channel must be verified before it can be updated. See https://docs.unstructured.io/api-reference/api/workflow/update-workflow-notification-channel" + }, + "response": [] + }, + { + "name": "Delete a workflow email channel", + "request": { + "method": "DELETE", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels", + "" + ] + }, + "description": "Permanently delete a workflow-scoped notification channel. This action is not recoverable. See https://docs.unstructured.io/api-reference/api/workflow/delete-workflow-notification-channel" + }, + "response": [] + }, + { + "name": "List workflow email channels", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels?channel_type=email", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels" + ], + "query": [ + { + "key": "channel_type", + "value": "email" + } + ] + }, + "description": "List all email notification channels scoped to the specified workflow. See https://docs.unstructured.io/api-reference/api/workflow/list-workflow-notification-channels" + }, + "response": [] + } + ] + } + ] +} diff --git a/postman/unstructured-webhooks.postman_collection.json b/postman/unstructured-webhooks.postman_collection.json new file mode 100644 index 0000000..ec6e5c1 --- /dev/null +++ b/postman/unstructured-webhooks.postman_collection.json @@ -0,0 +1,506 @@ +{ + "info": { + "_postman_id": "375918d0-5af6-4a9a-ada7-36f98eb6bcd3", + "name": "Unstructured Webhooks", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Workspace-scoped channels", + "item": [ + { + "name": "Create a webhook channel", + "request": { + "method": "POST", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Specify the settings for the workspace webhook notification channel here.\n // See https://docs.unstructured.io/api-reference/webhooks\n // API reference: https://docs.unstructured.io/api-reference/api/notification/create-notification-channel\n \"channel_type\": \"webhook\",\n \"url\": \"https://hooks.example.com/notify\",\n \"event_types\": [\"job.scheduled\", \"job.in_progress\", \"job.completed\", \"job.stopped\", \"job.failed\"],\n \"description\": \"Workspace job status alerts\",\n \"secret\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels" + ] + }, + "description": "Create a workspace-scoped webhook notification channel that delivers job event payloads to the specified HTTPS URL. The response includes the channel ID. See https://docs.unstructured.io/api-reference/webhooks" + }, + "response": [] + }, + { + "name": "Get a webhook channel", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels", + "" + ] + }, + "description": "Get a workspace-scoped webhook notification channel by ID. See https://docs.unstructured.io/api-reference/api/notification/get-notification-channel" + }, + "response": [] + }, + { + "name": "Update a webhook channel", + "request": { + "method": "PATCH", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Specify the fields to update for the workspace webhook notification channel here.\n // See https://docs.unstructured.io/api-reference/webhooks\n // API reference: https://docs.unstructured.io/api-reference/api/notification/update-notification-channel\n \"event_types\": [\"job.scheduled\", \"job.in_progress\", \"job.completed\", \"job.stopped\", \"job.failed\"],\n \"url\": \"https://hooks.example.com/notify\",\n \"enabled\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels", + "" + ] + }, + "description": "Update a workspace-scoped webhook notification channel; only provided fields are changed. To rotate the signing secret, include the new value in the `secret` field. See https://docs.unstructured.io/api-reference/api/notification/update-notification-channel" + }, + "response": [] + }, + { + "name": "Delete a webhook channel", + "request": { + "method": "DELETE", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels", + "" + ] + }, + "description": "Permanently delete a workspace-scoped webhook notification channel. This action is not recoverable. See https://docs.unstructured.io/api-reference/api/notification/delete-notification-channel" + }, + "response": [] + }, + { + "name": "List webhook channels", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/channels?channel_type=webhook", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "channels" + ], + "query": [ + { + "key": "channel_type", + "value": "webhook" + } + ] + }, + "description": "List all workspace-scoped webhook notification channels. See https://docs.unstructured.io/api-reference/api/notification/list-notification-channels" + }, + "response": [] + } + ] + }, + { + "name": "Workflow-scoped channels", + "item": [ + { + "name": "Create a workflow webhook channel", + "request": { + "method": "POST", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Specify the settings for the workflow webhook notification channel here.\n // See https://docs.unstructured.io/api-reference/webhooks\n // API reference: https://docs.unstructured.io/api-reference/api/workflow/create-workflow-notification-channel\n \"channel_type\": \"webhook\",\n \"url\": \"https://hooks.example.com/notify\",\n \"event_types\": [\"job.scheduled\", \"job.in_progress\", \"job.completed\", \"job.stopped\", \"job.failed\"],\n \"description\": \"Workflow job status alerts\",\n \"secret\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels" + ] + }, + "description": "Create a webhook notification channel scoped to a single workflow that delivers job event payloads to the specified HTTPS URL. The response includes the channel ID. See https://docs.unstructured.io/api-reference/webhooks" + }, + "response": [] + }, + { + "name": "Get a workflow webhook channel", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels", + "" + ] + }, + "description": "Get a workflow-scoped webhook notification channel by ID. See https://docs.unstructured.io/api-reference/api/workflow/get-workflow-notification-channel" + }, + "response": [] + }, + { + "name": "Update a workflow webhook channel", + "request": { + "method": "PATCH", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Specify the fields to update for the workflow webhook notification channel here.\n // See https://docs.unstructured.io/api-reference/webhooks\n // API reference: https://docs.unstructured.io/api-reference/api/workflow/update-workflow-notification-channel\n \"event_types\": [\"job.scheduled\", \"job.in_progress\", \"job.completed\", \"job.stopped\", \"job.failed\"],\n \"url\": \"https://hooks.example.com/notify\",\n \"enabled\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels", + "" + ] + }, + "description": "Update a workflow-scoped webhook notification channel; only provided fields are changed. To rotate the signing secret, include the new value in the `secret` field. See https://docs.unstructured.io/api-reference/api/workflow/update-workflow-notification-channel" + }, + "response": [] + }, + { + "name": "Delete a workflow webhook channel", + "request": { + "method": "DELETE", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels", + "" + ] + }, + "description": "Permanently delete a workflow-scoped webhook notification channel. This action is not recoverable. See https://docs.unstructured.io/api-reference/api/workflow/delete-workflow-notification-channel" + }, + "response": [] + }, + { + "name": "List workflow webhook channels", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/workflows//notifications/channels?channel_type=webhook", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "workflows", + "", + "notifications", + "channels" + ], + "query": [ + { + "key": "channel_type", + "value": "webhook" + } + ] + }, + "description": "List all webhook notification channels scoped to the specified workflow. See https://docs.unstructured.io/api-reference/api/workflow/list-workflow-notification-channels" + }, + "response": [] + } + ] + }, + { + "name": "Notifications", + "item": [ + { + "name": "Get a notification", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "" + ] + }, + "description": "Get a single webhook notification event by ID. See https://docs.unstructured.io/api-reference/api/notification/get-notification" + }, + "response": [] + }, + { + "name": "Get unread notification count", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/unread-count", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "unread-count" + ] + }, + "description": "Get the count of unread notification events for the current user. See https://docs.unstructured.io/api-reference/api/notification/get-notifications-unread-count" + }, + "response": [] + }, + { + "name": "Mark notifications read", + "request": { + "method": "POST", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n // Specify exactly one of: notification_ids, before, or mark_all.\n // See https://docs.unstructured.io/api-reference/webhooks\n // API reference: https://docs.unstructured.io/api-reference/api/notification/mark-notifications-read\n \"notification_ids\": [\"\", \"\"]\n // \"before\": \"\"\n // \"mark_all\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications/mark-read", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications", + "mark-read" + ] + }, + "description": "Mark one or more notification events as read for the current user. Provide exactly one of `notification_ids`, `before`, or `mark_all`. See https://docs.unstructured.io/api-reference/api/notification/mark-notifications-read" + }, + "response": [] + }, + { + "name": "List notifications", + "request": { + "method": "GET", + "header": [ + { + "key": "unstructured-api-key", + "value": "{{UNSTRUCTURED_API_KEY}}", + "type": "text" + } + ], + "url": { + "raw": "{{UNSTRUCTURED_API_URL}}/notifications?limit=50&unread_only=false", + "host": [ + "{{UNSTRUCTURED_API_URL}}" + ], + "path": [ + "notifications" + ], + "query": [ + { + "key": "limit", + "value": "50" + }, + { + "key": "unread_only", + "value": "false" + } + ] + }, + "description": "List notification events for the current user, ordered by creation date with cursor-based pagination. See https://docs.unstructured.io/api-reference/api/notification/list-notifications" + }, + "response": [] + } + ] + } + ] +}