Skip to main content
POST
/
api
/
v1
/
notifications
/
channels
Create Channel
curl --request POST \
  --url https://platform.unstructuredapp.io/api/v1/notifications/channels \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_types": [
    "job.scheduled"
  ],
  "url": "<string>",
  "channel_type": "webhook",
  "description": "<string>",
  "enabled": true,
  "secret": "<string>"
}
'
{
  "id": "<string>",
  "event_types": [
    "<string>"
  ],
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "channel_type": "webhook",
  "description": "<string>"
}

Headers

​
unstructured-api-key
string | null

Body

application/json

Request to create a webhook notification channel.

​
event_types
enum<string>[]
required

Event types to subscribe to

Minimum array length: 1

Webhook event types derived from internal JOB_STATUSCHANGED_V1 statuses.

Available options:
job.scheduled,
job.in_progress,
job.completed,
job.stopped,
job.failed
​
url
string
required

Webhook endpoint URL (HTTPS required)

​
channel_type
string
default:webhook
Allowed value: "webhook"
​
description
string | null

Channel description

Maximum string length: 255
​
enabled
boolean
default:true

Enable/disable channel

​
secret
string | null

Consumer-supplied signing secret (24-75 bytes)

Response

Successful Response

Response for webhook notification channel.

​
id
string
required

Channel ID

​
event_types
string[]
required

Subscribed event types

​
enabled
boolean
required

Channel enabled status

​
created_at
string<date-time>
required

Creation timestamp

​
updated_at
string<date-time>
required

Last update timestamp

​
url
string
required

Webhook endpoint URL

​
channel_type
string
default:webhook
Allowed value: "webhook"
​
description
string | null

Channel description